API REFERENCE · SCHEMA

Webhooks schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas

endpointsRequired

object[]

endpoints item fields

Each array item: object.

endpoints[].idRequired: string
Format: uuid.
endpoints[].environmentRequired: string
Values: "sandbox", "production".
endpoints[].urlRequired: string
endpoints[].activeRequired: boolean
endpoints[].created_atRequired: string
Format: date-time.

deliveriesRequired

object[]

deliveries item fields

Each array item: object.

deliveries[].idRequired: string
Format: uuid.
deliveries[].environmentRequired: string
Values: "sandbox", "production".
deliveries[].endpoint_idRequired: string
Format: uuid.
deliveries[].event_idRequired: string
deliveries[].statusRequired: string
deliveries[].attemptsRequired: integer
Minimum: 0.
deliveries[].next_attempt_atRequired: string
Format: date-time.
deliveries[].last_statusRequired: integer or null
May be null.; deliveries[].last_status fields and rules
Allowed alternatives
integer
Minimum: 0.
null
May be null.
deliveries[].created_atRequired: string
Format: date-time.