Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Webhook

List webhooks

List all webhooks for the workspace with optional filters

get/api/v2/webhooks

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:01956fbd-0eb1-72db-a565-82977a586084

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

campaignstring uuid
Example:019f94cd-af6c-7550-8fa4-814bf1080f0c

Filter by campaign ID

event_type'all_events' | 'email_sent' | 'email_opened' | 'email_link_clicked' | 'reply_received' | 'email_bounced' | 'lead_unsubscribed' | 'campaign_completed' | 'account_error' | 'lead_neutral' | 'lead_interested' | 'lead_not_interested' | 'lead_meeting_booked' | 'lead_meeting_completed' | 'lead_closed' | 'lead_out_of_office' | 'lead_wrong_person'
Example:all_events

Filter by event type (e.g., email_sent, lead_interested, all_events)

Response

The list of Webhook

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example response

{
  "items": [
    {
      "id": "019f94cd-77fd-74f3-ac4a-dd7f7d7b5be6",
      "organization": "019f94cd-77fd-74f3-ac4a-dd8009edca34",
      "campaign": "019f94cd-77fd-74f3-ac4a-dd8150594714",
      "name": "Zapier Positive Replies",
      "target_hook_url": "https://webhook.site/unique-url",
      "event_type": "email_sent",
      "custom_interest_value": 1,
      "headers": {
        "Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
      },
      "timestamp_created": "2026-07-24T15:45:21.405Z",
      "status": 1,
      "timestamp_error": "2026-07-24T15:45:21.405Z"
    }
  ],
  "next_starting_after": "019f94cd-af6c-7550-8fa4-814cd33bde60"
}