All-agent notifications

webhook

Agent Notification URL - All Agents

Send lead payloads to a URL when any profile receives a lead offer, reminder, catchall notification, test notification, or accepted-lead notification. This can be set in the Agent Notification URL - All agents section of Settings>Advanced

Payload

Agent notification payload. Offer, reminder, catchall and test notifications contain limited lead context; accepted notifications start with the full outbound lead snapshot and then overwrite lead tags/hints and recipient profile contact fields. Conditional fields may be omitted.

action

string

Lead notification action.

action_type

string

The current sender reads self::$classType on the base class, so this is Abstract for all notification subclasses, including offers, reminders and catchall. Use action to distinguish events; future implementations may change this value.

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

Full snapshot for accepted notifications; other notification types normally include only tags and hints.

profile

object

Recipient contact fields, replaced with vacation-handler contact fields when applicable. Accepted snapshots may also retain accepting-profile identifiers and other attributes.

history

object | null

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

accepted_time

string | null

Accepted history action timestamp, or null when no accepted history exists. Included in accepted notification snapshots; omitted from limited-context notifications.

followup_notification

object

Included only when follow-up trail data produces a summary.

hubspot_deal_id

string

Conditional Deckorators plugin field extracted from lead text. May be retained in accepted notification snapshots.

hubspot_contact_id

string

Conditional Deckorators plugin field extracted from lead text. May be retained in accepted notification snapshots.

hubspot_lead_id

string

Conditional Deckorators plugin field extracted from lead text. May be retained in accepted notification snapshots.

hubspot_lead_status

integer

Conditional Deckorators plugin field for closed leads. May be retained in accepted notification snapshots.

Responses

200

Webhook payload accepted successfully.

default

The receiver did not accept the webhook payload.