/webhooks

Subscribe to a new webhook.

🚧

Restricted Access

Creating new webhooks is restricted to the account owner and registered systems only.

📘

Detailed Webhook Guide

For more details and information about webhooks, see the full guide here.

Body Params
string
enum
required

The event the webook responds to. This should be one of the following: peopleCreated, peopleUpdated, peopleDeleted, peopleTagsCreated, peopleStageUpdated, peopleRelationshipCreated,peopleRelationshipUpdated,peopleRelationshipDeleted, notesCreated, notesUpdated, notesDeleted, emEventsOpened, emEventsClicked, emEventsUnsubscribed, tasksCreated, tasksUpdated, tasksDeleted, appointmentsCreated, appointmentsUpdated, appointmentsDeleted, textMessagesCreated, textMessagesUpdated, textMessagesDeleted, callsCreated, callsUpdated, callsDeleted, dealsCreated, dealsUpdated, dealsDeleted, emailsCreated, emailsUpdated, emailsDeleted, eventsCreated, stageCreated, stageUpdated, or stageDeleted

string
required

The url of the webhook. Must be a secure endpoint (https).

Headers
string
required

The name of the registered system.

string
required

The key of the registered system.

Responses

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json