Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

Body

application/json

Request body

Request body

name
string
required

Label identifying this webhook in the workspace.

Example:

"Reply notifications"

type
enum<string>
required

Event that triggers a delivery. A webhook subscribes to exactly one type, so receiving several events means registering several webhooks.

Available options:
email_sent,
email_opened,
link_clicked,
email_replied,
linkedin_replied,
contact_unsubscribed,
email_bounced,
positive_reply,
negative_reply,
label_changed,
dnc_added,
meeting_booked,
meeting_completed,
linkedin_message_sent,
linkedin_inmail_sent,
linkedin_connection_request_sent,
linkedin_connection_request_accepted,
linkedin_connection_request_withdrawn,
linkedin_profile_viewed,
linkedin_post_liked,
linkedin_contact_followed,
email_sent,
email_opened,
link_clicked,
email_replied,
linkedin_replied,
contact_unsubscribed,
email_bounced,
positive_reply,
negative_reply,
label_changed,
dnc_added,
meeting_booked,
meeting_completed,
linkedin_message_sent,
linkedin_inmail_sent,
linkedin_connection_request_sent,
linkedin_connection_request_accepted,
linkedin_connection_request_withdrawn,
linkedin_profile_viewed,
linkedin_post_liked,
linkedin_contact_followed
url
string
required

Endpoint receiving the POST. Must be publicly reachable and answer 2xx: a failed delivery is not retried.

Example:

"https://example.com/webhooks/salesforge"

sequenceID
string

Deprecated: use sequenceIds. Ignored when sequenceIds is non-empty.

Minimum string length: 1
Example:

"seq_abc123"

sequenceIds
string[]

Sequences whose events this webhook receives. Omit or leave empty to receive events for every sequence in the workspace.

Example:

Response

Created webhook. The signingSecret is returned only here and cannot be retrieved later.

id
string
name
string
sentCount
integer
sequenceId
string
sequenceIds
string[]
signingSecret
string

SigningSecret is returned exactly once, at creation, and cannot be retrieved afterwards.

type
enum<string>

Event that triggers a delivery. A webhook subscribes to exactly one type, so receiving several events means registering several webhooks.

Available options:
email_sent,
email_opened,
link_clicked,
email_replied,
linkedin_replied,
contact_unsubscribed,
email_bounced,
positive_reply,
negative_reply,
label_changed,
dnc_added,
meeting_booked,
meeting_completed,
linkedin_message_sent,
linkedin_inmail_sent,
linkedin_connection_request_sent,
linkedin_connection_request_accepted,
linkedin_connection_request_withdrawn,
linkedin_profile_viewed,
linkedin_post_liked,
linkedin_contact_followed,
email_sent,
email_opened,
link_clicked,
email_replied,
linkedin_replied,
contact_unsubscribed,
email_bounced,
positive_reply,
negative_reply,
label_changed,
dnc_added,
meeting_booked,
meeting_completed,
linkedin_message_sent,
linkedin_inmail_sent,
linkedin_connection_request_sent,
linkedin_connection_request_accepted,
linkedin_connection_request_withdrawn,
linkedin_profile_viewed,
linkedin_post_liked,
linkedin_contact_followed
url
string