Skip to main content

A webhook subscription. The subscription fires a single event type to a configured URL when activity matching the subscription's scope occurs.

​
id
integer
read-only

Unique identifier for the webhook subscription.

​
eventType
string

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

Example:

"email_replied"

​
url
string<uri>

Absolute http/https URL that receives the webhook payload.

Example:

"https://example.com/hooks/reply"

​
scope
enum<string>

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).
Available options:
personal,
team,
organization
Example:

"personal"

​
enabled
boolean

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.

​
createdAt
string<date-time>
read-only

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

​
payloadConfig
WebHookPayloadConfig · object

Optional flags that enrich the delivered webhook payload with extra fields from the originating email/contact.

Example:
{
  "includeEmailUrl": true,
  "includeEmailText": false,
  "includeProspectCustomFields": true
}