Webhook URL

wbhk

Webhook Notification URLs

Send lead payloads to a URL when a specific profile receives a lead offer, reminder, catchall notification, test notification, or accepted-lead notification. This can be set in the Webhook Notification URLs section of the profile sidebar

Payload

Payload sent to agent notification webhook URLs.

action

string

Lead notification action.

action_type

string

Notification type.

action_url

string

URL the agent can use to act on or view the lead.

action_url_https

string

HTTPS version of action_url.

suggestedMessage

string

Human-readable message generated by goBluebird.

text

string

Slack-compatible text fallback. Usually includes suggestedMessage and action_url.

on_vacation

boolean

Whether the originally selected profile was on vacation.

lead

object

Lead notification context. May include tags, hints, or full lead details depending on event type.

profile

object

Profile receiving the notification, or vacation-handler profile when applicable.

history

object | null

Lead-history context when the webhook is tied to a specific lead-history key.

Responses

200

Webhook payload accepted successfully.

default

The receiver did not accept the webhook payload.

Loading…