Webhooks
Create a webhook
Create a new webhook.
post/v1/webhooks
Request body
urlstring uri required
The URL of the webhook endpoint.
descriptionstring nullable
An optional description of what the webhook is used for.
enabled_eventsstring[] required
The list of events to enable for this endpoint.
disabledboolean nullable
Indicates that the webhook is disabled
Response
idstring
A unique identifier
urlstring uri required
The URL of the webhook endpoint.
descriptionstring nullable
An optional description of what the webhook is used for.
enabled_eventsstring[] required
The list of events to enable for this endpoint.
disabledboolean nullable
Indicates that the webhook is disabled
object_typestring
Specifies the object type
last_event_atstring date-time nullable
The datetime of the last event sent.
secretstring required
Header signature secret
test_modeboolean required
Specified whether it was created with a carrier in test mode