SitesWebhooks

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
* `form_submission` - Sends the [form_submission](#form_submission) event * `site_publish` - Sends a [site_publish](#site_publish) event * `ecomm_new_order` - Sends the new [ecomm_new_order](#ecomm_new_order) event * `ecomm_order_changed` - Sends the [ecomm_order_changed](#ecomm_order_changed) event * `ecomm_inventory_changed` - Sends the [ecomm_inventory_changed](#ecomm_inventory_changed) event * `memberships_user_account_added` - Sends the [memberships_user_account_added](#memberships_user_account_added) event * `memberships_user_account_updated` - Sends the [memberships_user_account_updated](#memberships_user_account_updated) event * `memberships_user_account_deleted` - Sends the [memberships_user_account_deleted](#memberships_user_account_deleted) event * `collection_item_created` - Sends the [collection_item_created](#collection_item_created) event * `collection_item_changed` - Sends the [collection_item_changed](#collection_item_changed) event * `collection_item_deleted` - Sends the [collection_item_deleted](#collection_item_deleted) event * `collection_item_unpublished` - Sends the [collection_item_unpublished](#collection_item_unpublished) event * `comment_created` - Sends the [comment_created](#comment_created) event
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
* `form_submission` - Sends the [form_submission](#form_submission) event * `site_publish` - Sends a [site_publish](#site_publish) event * `ecomm_new_order` - Sends the new [ecomm_new_order](#ecomm_new_order) event * `ecomm_order_changed` - Sends the [ecomm_order_changed](#ecomm_order_changed) event * `ecomm_inventory_changed` - Sends the [ecomm_inventory_changed](#ecomm_inventory_changed) event * `memberships_user_account_added` - Sends the [memberships_user_account_added](#memberships_user_account_added) event * `memberships_user_account_updated` - Sends the [memberships_user_account_updated](#memberships_user_account_updated) event * `memberships_user_account_deleted` - Sends the [memberships_user_account_deleted](#memberships_user_account_deleted) event * `collection_item_created` - Sends the [collection_item_created](#collection_item_created) event * `collection_item_changed` - Sends the [collection_item_changed](#collection_item_changed) event * `collection_item_deleted` - Sends the [collection_item_deleted](#collection_item_deleted) event * `collection_item_unpublished` - Sends the [collection_item_unpublished](#collection_item_unpublished) event * `comment_created` - Sends the [comment_created](#comment_created) event
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