Webhook Subscriptions

Please review the Webhooks documentation for more details.

The following API can be used to manage your Webhook subscriptions.

List Webhook subscriptions.

GET /webhook/

The response contains the subscriptions for your organization.

Create new Webhook subscription.

POST /webhook/

The subscription will send events to the specified URL.

Parameters:

• url - Destination URL for the webhook subscription
• events - A list of events to subscribe to. Each event has an object_type and an action from values in the event log. You can also use Webhook Filters while creating your subscription so that an event only fires to a Webhook when certain conditions are met.
• verify_ssl (optional)
  • true (default) - Verify SSL certificate of destination webhook URL.
  • false - Disable SSL certificate validation on destination webhook URL. We recommend using https to protect your data during delivery.

Retrieve a single Webhook subscription.

GET /webhook/{id}/

The response contains the subscription details.

Update existing Webhook subscription.

PUT /webhook/{id}/

All parameters are optional. Only the parameters that are provided will be updated.

Parameters:

• url - Destination URL for the webhook subscription
• events - A list of events to subscribe to. Each event has an object_type and an action from values in the event log. You can also use Webhook Filters while creating your subscription so that an event only fires to a Webhook when certain conditions are met.
• status - Subscription status
  • active - activate the subscription
  • paused - pause the subscription
• verify_ssl
  • false - Disable SSL certificate validation on destination webhook URL. We recommend using https to protect your data during delivery.
  • true - Verify SSL certificate of destination webhook URL.

Delete Webhook subscription.

DELETE /webhook/{id}/