WebhookEvent

An outbound webhook event a subscriber can register for.

The wire form is dot-separated (order.created) — that is what the X-Kesk-Event header carries, what the payload's eventType key holds, and what is stored against the subscription. The GraphQL and OpenAPI spellings differ only because a GraphQL enum value cannot contain a dot.

Valid values

    BOOKING_CANCELLED
    string
    Triggered when a booking is cancelled
    BOOKING_COMPLETED
    string
    Triggered when a booking is completed
    BOOKING_CONFIRMED
    string
    Triggered when a booking is confirmed
    BOOKING_CREATED
    string
    Triggered when a new booking is created
    CUSTOMER_MESSAGE
    string
    Triggered when a customer sends a message
    ORDER_ASSIGNED
    string
    Triggered when a driver is assigned to an order
    ORDER_CANCELLED
    string
    Triggered when an order is cancelled
    ORDER_COMPLETED
    string
    Triggered when an order is completed
    ORDER_CREATED
    string
    Triggered when a new order is placed
    ORDER_UPDATED
    string
    Triggered when an order is updated
    PAYMENT_RECEIVED
    string
    Triggered when a payment is received
    PAYMENT_REFUNDED
    string
    Triggered when a payment is refunded
    PRODUCT_LOW_STOCK
    string
    Triggered when a product's stock is low
    REVIEW_CREATED
    string
    Triggered when a customer leaves a review
    UNIT_ASSIGNED
    string
    Triggered when an autonomous unit accepts an order
    UNIT_DELIVERY_COMPLETED
    string
    Triggered when an autonomous unit completes a delivery
    UNIT_MAINTENANCE_REQUIRED
    string
    Triggered when an autonomous unit reports it needs servicing
    UNIT_REGISTERED
    string
    Triggered when an autonomous delivery unit is registered
    UNIT_STATUS_CHANGED
    string
    Triggered when an autonomous unit's operational status changes
    UNIT_TELEMETRY_ALERT
    string
    Triggered on a low-battery or geofence-breach alert from a unit (rate-limited per unit and alert type)
    UNIT_VERIFIED
    string
    Triggered when an autonomous unit passes verification
Built with