POST /sites/{site_id}/webhooks

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

Servers

Path parameters

Name Type Required Description
site_id String Yes

Unique identifier for a Site

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

Unique identifier for the Webhook registration

url String No

URL to send the Webhook payload to

filter Object No

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

filter.name String No

The name of the form you'd like to recieve notifications for.

lastTriggered String No

Date the Webhook instance was last triggered

createdOn String No

Date the Webhook registration was created

workspaceId String No

Unique identifier for the Workspace the Webhook is registered in

siteId String No

Unique identifier for the Site the Webhook is registered in

triggerType String No

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

Possible values:

  • "comment_created"
  • "form_submission"
  • "site_publish"
  • "page_metadata_updated"
  • "page_deleted"
  • "user_account_added"
  • "user_account_deleted"
  • "ecomm_order_changed"
  • "collection_item_changed"
  • "user_account_updated"
  • "collection_item_unpublished"
  • "page_created"
  • "collection_item_created"
  • "ecomm_new_order"
  • "collection_item_deleted"
  • "ecomm_inventory_changed"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.