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
_idstring or nullformat: "uuid"
Unique identifier for a Webhook
triggerTypeenum or null
triggerIdstring or nullformat: "uuid"
Unique identifier for the Webhook Trigger
sitestring or nullformat: "uuid"
Unique identifier for a Webhook
filterobject or null
filter for selecting which events you want webhooks to be triggered for.
lastUsedstring or nullformat: "date-time"
Date trigger was last used
createdOnstring or nullformat: "date-time"
Date trigger was created

Errors