Webhooks

Create Webhook

Create a new Webhook.

Limit of 75 registrations per triggerType, per site.

Access to this endpoint requires a bearer token from a Data Client App.
Required scope | sites:write

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Headers

AuthorizationstringRequired

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

Request

The Webhook registration object

idstringOptionalformat: "objectid"

Unique identifier for the Webhook registration

triggerTypeenumOptional

The type of event that triggered the request. See the the documentation for details on supported events.

urlstringOptional

URL to send the Webhook payload to

workspaceIdstringOptionalformat: "objectid"

Unique identifier for the Workspace the Webhook is registered in

siteIdstringOptionalformat: "objectid"

Unique identifier for the Site the Webhook is registered in

filterobjectOptional

Only supported for the form_submission trigger type. Filter for the form you want Webhooks to be sent for.

lastTriggeredstringOptionalformat: "date-time"

Date the Webhook instance was last triggered

createdOnstringOptionalformat: "date-time"

Date the Webhook registration was created

Response

Request was successful

idstringOptionalformat: "objectid"

Unique identifier for the Webhook registration

triggerTypeenumOptional

The type of event that triggered the request. See the the documentation for details on supported events.

urlstringOptional

URL to send the Webhook payload to

workspaceIdstringOptionalformat: "objectid"

Unique identifier for the Workspace the Webhook is registered in

siteIdstringOptionalformat: "objectid"

Unique identifier for the Site the Webhook is registered in

filterobjectOptional

Only supported for the form_submission trigger type. Filter for the form you want Webhooks to be sent for.

lastTriggeredstringOptionalformat: "date-time"

Date the Webhook instance was last triggered

createdOnstringOptionalformat: "date-time"

Date the Webhook registration was created

Errors