Webhooks

Add Webhook

Add a webhook for events enrollments.

post/v1/webhooks

Request body

request_contextobject nullable
partner_idstring required
webhook_urlstring required
headersstring[]
payload_format'json' | 'stringified_json'

An enumeration.

Response

Successful Response

created_atstring date-time required
last_modified_timestring date-time required
webhook_urlstring required
webhook_secretstring required
headersstring[]
payload_format'json' | 'stringified_json'

An enumeration.

Changes

Changed in 2 of the 11 revisions of this API.22

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog