Create hook

Creates a new webhook subscription

Request Body

The request must include:

• data - parent object which includes the children/nested attributes:
• target_url - The URL where webhook events will be sent
• event - The type of event to subscribe to (see available events below), for example “tag_added”
• resource_id (optional) - Specific resource ID to filter events for, for example the id of the Contact Tag. When the property is omitted, the webhook will be triggered for all events of the specified type, as a wildcard webhook.

Available Event Types

Note: You can only create webhooks for events you have permission to access based on your API key scopes. For example to use tags you need the view:contacts scope, which is included in the account owner api key scope.

Sample Payloads

You can view sample webhook payloads for each event type:

• GET /api/v1/hooks/purchase_sample
• GET /api/v1/hooks/payment_succeeded_sample
• GET /api/v1/hooks/order_created_sample
• GET /api/v1/hooks/form_submission_sample
• GET /api/v1/hooks/tag_added_sample
• GET /api/v1/hooks/tag_removed_sample

Example request targeting a specific tag:

{
  "data": {
    "type": "hooks",
    "attributes": {
      "target_url": "https://example.com/webhook",
      "event": "tag_added",
      "resource_id": "123"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "456",
          "type": "sites"
        }
      }
    }
  }
}

Example request using a wildcard webhook:

{
  "data": {
    "type": "hooks",
    "attributes": {
      "target_url": "https://example.com/webhook",
      "event": "tag_added"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "456",
          "type": "sites"
        }
      }
    }
  }
}

Actual Payloads

The actual payloads are sent to the target_url as a POST request with the following JSON body:

{
  "id": "hash_id",
  "event": "tag_added",
  "payload": [],
}

The id is the ID of the resource that triggered the event. The event is the type of event that triggered the webhook. The payload is the actual payload of the event and the content will be similar to the sample payloads above.