v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Webhook

Create a Webhook

post/webhook

Request body

basic_secretstring

The password value sent as part of basic Authorization for request validation. Always shown as null in all responses.

basic_userstring

The user value sent as part of basic Authorization for request validation. Use is optional.

eventstring required

The event to listen for. Available events

urlstring required

The HTTPS URL where the event notification will be sent

userdataobject

Optional arbitrary user data

Response

The webhook created

basic_secretstring

The password value sent as part of basic Authorization for request validation. Always shown as null in all responses.

basic_userstring

The user value sent as part of basic Authorization for request validation. Use is optional.

errorstring

The error reason, if the webhook has transitioned status to error

eventstring

The event to listen for. Available events

idstring

Unique identifier for object

statusstring

One of enabled, disabled, or error. Filterable.

urlstring

The HTTPS URL where the event notification will be sent

userdataobject

Optional arbitrary user data