Create Webhook

Create a new webhook

Path parameters

site_idstringRequiredformat: "uuid"

Unique identifier for a Site

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Accept-VersionstringOptional

The API version

Request

The webhook item to create

triggerTypeenumRequired
urlstringRequiredformat: "uri"

The https URL on your server the webhook will send a request to when the webhook is triggered

filterobjectOptional

filter for selecting which events you want webhooks to be triggered for. ** Only available for form_submission trigger types.

Response

Request was successful

_idstringOptionalformat: "uuid"

Unique identifier for a Webhook

triggerTypeenumOptional
triggerIdstringOptionalformat: "uuid"

Unique identifier for the Webhook Trigger

sitestringOptionalformat: "uuid"

Unique identifier for a Webhook

filterobjectOptional

filter for selecting which events you want webhooks to be triggered for.

lastUsedstringOptionalformat: "date-time"

Date trigger was last used

createdOnstringOptionalformat: "date-time"

Date trigger was created

Errors