Skip to main content
POST
Create a webhook
Subscribe a URL to one or more events. name defaults to the URL’s host. The response carries the signing secret. It is shown once, so store it before you do anything else. Use it to verify each delivery. The URL must be https or http. Private, loopback and cloud metadata addresses are refused with blocked_internal_host.

Authorizations

Authorization
string
header
required

Workspace API key. Create one in Settings → API keys.

Body

application/json
url
string<uri>
required

Where we POST events. https or http; private and internal hosts are refused.

events
enum<string>[]
required

Event types to receive. See GET /v2/webhooks/events.

Available options:
conversation.call_ended,
conversation.reply_received,
deal.won,
deal.lost,
deal.stage_changed,
interaction.email_received,
interaction.email_bounced,
interaction.linkedin_connection_accepted,
interaction.linkedin_message_received,
interaction.meeting_scheduled,
interaction.meeting_held
name
string

Defaults to the URL's host.

Response

Created. secret is shown only in this response.

webhook
object

A subscription. The signing secret is never returned here; you get it once on create and on rotate.

secret
string