v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Webhooks

Get a webhook subscription

<small>Requires the webhooks:read scope (or a broader one that includes it).</small>

Returns a single webhook subscription owned by the authenticated user.

get/v3/webhooks/{id}

Path parameters

idinteger required

Webhook subscription ID.

Response

Webhook subscription details.

idinteger

Unique identifier for the webhook subscription.

eventTypestring

Event type this subscription fires on. One of the values returned by GET /v3/webhooks/events.

urlstring uri

Absolute http/https URL that receives the webhook payload.

scope'personal' | 'team' | 'organization'

Scope that determines which users' activity triggers the webhook.

personal — fires only for activity of the subscription owner.
team — fires for activity of any member of the owner's team. Creation requires the current user to be the team owner for private teams; anyone can create for public teams.
organization — reserved for future use. The API currently rejects creation/update with this value (errorCode: 5).

enabledboolean

If false, the subscription does not fire. Toggle via the dedicated POST /v3/webhooks/{id}/enable and POST /v3/webhooks/{id}/disable endpoints — the state cannot be changed through PUT.

createdAtstring date-time

ISO-8601 timestamp (UTC) when the subscription was created.

Example response

{
  "id": 1823,
  "eventType": "email_replied",
  "url": "https://example.com/hooks/reply",
  "scope": "personal",
  "enabled": true,
  "createdAt": "2026-04-17T12:00:00+00:00",
  "payloadConfig": {
    "includeEmailUrl": true,
    "includeEmailText": false,
    "includeProspectCustomFields": true
  }
}