Webhooks

  1. List subscriptions
  2. Create subscription
  3. Update subscription

List subscriptions

GET /webhooks/subscription

List all webhook subscriptions the API consumer’s brand.

All webhook subscriptions will be returned, including subscriptions which are not currently active.

Response

{
    "subscriptions":
    [
        {
            "id": 101,
            "event": "site.publish",
            "url": "https://hooks.zapier.com/hooks/catch/123/abc/",
            "active":  true
        },
        {
            "id": 102,
            "event": "site.publish",
            "url": "https://webhook.site/4c8c8cf6-10c3-421c-b1a4-27831024afc9",
            "active":  false
        },
    ]
}

Create subscription

POST /webhooks/subscription

Create a new webhook subscription in the API consumer’s brand.

Input

event string Required. Event to subscribe to (currently only site.publish is supported)
url string Required. URL of webhook.
active boolean Required. 
{
    "event": "site.publish",
    "url": "https://hooks.zapier.com/hooks/catch/123/abc",
    "active": true
}

Response

Status: 201 Created

{
    "id": 104,
    "event": "site.publish",
    "url": "https://hooks.zapier.com/hooks/catch/123/abc",
    "active":  true
}

Update subscription

PUT /webhooks/subscription/:subscriptionId

Update a Webhook subscription.

Input

event string Required. Event to subscribe to (currently only site.publish is supported)
url string Required. URL of webhook.
active boolean Required. 
{
    "event": "site.publish",
    "url": "https://hooks.zapier.com/hooks/catch/123/abc",
    "active": true
}

Response

Status: 200 OK

{
    "id": 104,
    "event": "site.publish",
    "url": "https://hooks.zapier.com/hooks/catch/123/abc",
    "active":  true
}