Skip to main content
POST
Create a webhook

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

Body

application/json

Only these five fields are read. Anything else in the body is ignored.

url
string<uri>
required

An http or https URL.

events
enum<string>[]
required

The events to deliver. A value outside the list is refused with 422.

Available options:
connection_request_sent,
connection_request_accepted,
connection_request_withdrawn,
follow_up_message_sent,
message_replied,
message_success,
lead_finished,
lead_failed,
lead_status_not_interested,
lead_status_engaged,
lead_status_interested,
lead_status_hot_lead,
lead_status_meeting_booked,
lead_status_won,
lead_status_lost
name
string

Optional, like on the integrations page; a blank name is stored as none.

is_active
boolean

Defaults to true.

enrichment
enum<string>[]

What to enrich before each delivery. Omit or give an empty list for no enrichment. A value outside the list is refused with 422.

Available options:
linkedin_profile,
email,
phone

Response

Webhook created

An outbound webhook. Custom headers, if any were set on the integrations page, are never returned.

uuid
string<uuid>
name
string | null

The name is optional, so it is null for webhooks created without one.

url
string<uri>
is_active
boolean

Only active webhooks receive deliveries.

events
enum<string>[]

The events the webhook subscribes to. At least one. Fired when: connection_request_sent a LinkedIn connection request was sent to the lead; connection_request_accepted the lead accepted the connection request; connection_request_withdrawn a pending connection request was withdrawn; follow_up_message_sent a follow-up message was sent to the lead; message_replied the lead replied to a campaign message; message_success a message was sent or received in the unified inbox; lead_finished the lead completed the campaign; lead_failed the lead stopped in the campaign with a failure; lead_status_engaged, lead_status_interested, lead_status_hot_lead, lead_status_meeting_booked, lead_status_won, lead_status_not_interested, lead_status_lost the lead's pipeline status became that status.

Available options:
connection_request_sent,
connection_request_accepted,
connection_request_withdrawn,
follow_up_message_sent,
message_replied,
message_success,
lead_finished,
lead_failed,
lead_status_not_interested,
lead_status_engaged,
lead_status_interested,
lead_status_hot_lead,
lead_status_meeting_booked,
lead_status_won,
lead_status_lost
enrichment
enum<string>[]

What each delivery enriches the lead with first. An empty list means no enrichment.

Available options:
linkedin_profile,
email,
phone
created_at
string<date-time>
updated_at
string<date-time>