Webhooks

Get Webhook

Get a specific Webhook instance

Required scope: sites:read

Path parameters

webhook_idstringRequiredformat: "objectid"
Unique identifier for a Webhook

Headers

AuthorizationstringRequired

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

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