Webhook events
Every event type, when it is sent, and what `data.object` holds.
| Event | When | Opt-in |
|---|---|---|
ad_account.connected | Ad account connected | - |
ad_account.health_changed | Ad account health changed | - |
ad_campaign.billing_blocked | Ad campaign billing blocked | - |
ad_campaign.completed | Ad campaign completed | - |
ad_campaign.created | Ad campaign created | - |
ad.status_changed | Ad status changed | - |
ai.credits_used | Ai credits used | - |
ai.handoff_requested | Ai handoff requested | - |
ai.reply_suppressed | Ai reply suppressed | - |
api_key.created | Api key created | - |
api_key.revoked | Api key revoked | - |
api_key.rotated | Api key rotated | - |
approval.decided | Approval decided | - |
approval.requested | Approval requested | - |
asset_safety.changed | Asset safety changed | - |
assistant.activated | Assistant activated | - |
assistant.created | Assistant created | - |
assistant.deactivated | Assistant deactivated | - |
assistant.eval_regression_detected | Assistant eval regression detected | - |
assistant.eval_run_completed | Assistant eval run completed | - |
assistant.fact_updated | Assistant fact updated | - |
assistant.season_rolled_over | Assistant season rolled over | - |
assistant.updated | Assistant updated | - |
booking.attended | Booking attended | - |
booking.cancelled | Booking cancelled | - |
booking.created | Booking created | - |
booking.deposit_adjusted | Booking deposit adjusted | - |
booking.deposit_forfeited | Booking deposit forfeited | - |
booking.deposit_paid | Booking deposit paid | - |
booking.deposit_refunded | Booking deposit refunded | - |
booking.deposit_released | Booking deposit released | - |
booking.deposit_requested | Booking deposit requested | - |
booking.no_show | Booking no show | - |
booking.reminder_requested | Booking reminder requested | - |
booking.rescheduled | Booking rescheduled | - |
booking.updated | Booking updated | - |
business_verification.decided | Business verification decided | - |
business_verification.submitted | Business verification submitted | - |
call.balance_exhausted | Call balance exhausted | - |
call.completed | Call completed | - |
call.crm_applied | Call crm applied | - |
call.missed | Call missed | - |
call.outcome_recorded | Call outcome recorded | - |
call.permission_granted | Call permission granted | - |
call.permission_requested | Call permission requested | - |
call.permission_revoked | Call permission revoked | - |
call.recording_ready | Call recording ready | - |
call.started | Call started | - |
call.summary_ready | Call summary ready | - |
call.transcript_ready | Call transcript ready | - |
call.voicemail_left | Call voicemail left | - |
capi.sent | Capi sent | - |
cart.abandoned | Cart abandoned | - |
cart.purchased | Cart purchased | - |
cart.recovered | Cart recovered | - |
cart.recovery_message_sent | Cart recovery message sent | - |
catalog.created | Catalog created | - |
catalog.sync_started | Catalog sync started | - |
catalog.synced | Catalog synced | - |
channel.badge_approved | Channel badge approved | - |
channel.badge_rejected | Channel badge rejected | - |
channel.badge_submitted | Channel badge submitted | - |
channel.coexistence_sync_updated | Channel coexistence sync updated | yes (+channel.coexistence_sync_updated) |
channel.connected | Channel connected | - |
channel.disconnected | Channel disconnected | - |
channel.health_changed | Channel health changed | - |
channel.history_declined | Channel history declined | - |
channel.history_synced | Channel history synced | - |
channel.limit_changed | Channel limit changed | - |
channel.payment_state_changed | Channel payment state changed | - |
channel.private_lane_released | Channel private lane released | - |
channel.reconnected | Channel reconnected | - |
channel.routing_changed | Channel routing changed | - |
channel.sync_expired | Channel sync expired | - |
channel.token_expiring | Channel token expiring | - |
channel.username_released | Channel username released | - |
channel.username_reserved | Channel username reserved | - |
client_approval.decided | Client approval decided | - |
client_approval.requested | Client approval requested | - |
client_org.handover_completed | Client org handover completed | - |
client_org.handover_started | Client org handover started | - |
comment.received | Comment received | - |
contact.created | Contact created | - |
contact.deleted | Contact deleted | - |
contact.merged | Contact merged | - |
contact.opted_in | Contact opted in | - |
contact.opted_out | Contact opted out | - |
contact.stage_changed | Contact stage changed | - |
contact.tag_added | Contact tag added | - |
contact.tag_removed | Contact tag removed | - |
contact.updated | Contact updated | - |
conversation.assigned | Conversation assigned | - |
conversation.closed | Conversation closed | - |
conversation.created | Conversation created | - |
conversation.label_changed | Conversation label changed | - |
conversation.lane_changed | Conversation lane changed | - |
conversation.note_added | Conversation note added | - |
conversation.quality_low | Conversation quality low | - |
conversation.quality_scored | Conversation quality scored | - |
conversation.reopened | Conversation reopened | - |
conversation.sla_breached | Conversation sla breached | - |
conversation.sla_warned | Conversation sla warned | - |
conversation.snoozed | Conversation snoozed | - |
conversation.status_changed | Conversation status changed | - |
copilot.action_cancelled | Copilot action cancelled | - |
copilot.action_confirmed | Copilot action confirmed | - |
copilot.action_executed | Copilot action executed | - |
copilot.action_expired | Copilot action expired | - |
copilot.action_failed | Copilot action failed | - |
copilot.action_proposed | Copilot action proposed | - |
copilot.action_rejected | Copilot action rejected | - |
csat.low_score | Csat low score | - |
csat.requested | Csat requested | - |
csat.responded | Csat responded | - |
document.delivered | Document delivered | - |
document.delivery_expired | Document delivery expired | - |
document.delivery_revoked | Document delivery revoked | - |
document.delivery_sent | Document delivery sent | - |
document.delivery_verified | Document delivery verified | - |
document.request_completed | Document request completed | - |
document.request_item_accepted | Document request item accepted | - |
document.request_item_received | Document request item received | - |
document.request_item_rejected | Document request item rejected | - |
document.request_sent | Document request sent | - |
dsr.completed | Dsr completed | - |
dsr.created | Dsr created | - |
dsr.rejected | Dsr rejected | - |
dsr.verified | Dsr verified | - |
due_schedule.cancelled | Due schedule cancelled | - |
due_schedule.created | Due schedule created | - |
due.cancelled | Due cancelled | - |
due.created | Due created | - |
due.overdue | Due overdue | - |
due.paid | Due paid | - |
due.part_paid | Due part paid | - |
due.reminder_sent | Due reminder sent | - |
due.updated | Due updated | - |
due.waived | Due waived | - |
export.ready | Export ready | - |
export.requested | Export requested | - |
flow.created | Flow created | - |
flow.status_updated | Flow status updated | - |
form.submitted | Form submitted | - |
group.created | Group created | - |
group.deleted | Group deleted | - |
group.join_decided | Group join decided | - |
group.join_requested | Group join requested | - |
group.message_received | Group message received | - |
group.participant_joined | Group participant joined | - |
group.participant_removed | Group participant removed | - |
group.updated | Group updated | - |
helper.activated | Helper activated | - |
helper.archived | Helper archived | - |
helper.created | Helper created | - |
helper.deactivated | Helper deactivated | - |
helper.deleted | Helper deleted | - |
helper.paused | Helper paused | - |
helper.published | Helper published | - |
helper.resumed | Helper resumed | - |
helper.run_cancelled | Helper run cancelled | - |
helper.run_completed | Helper run completed | yes (+helper.run_completed) |
helper.run_failed | Helper run failed | - |
helper.run_started | Helper run started | yes (+helper.run_started) |
helper.updated | Helper updated | - |
import.completed | Import completed | - |
integration.connected | Integration connected | - |
integration.degraded | Integration degraded | - |
integration.disconnected | Integration disconnected | - |
integration.reauth_required | Integration reauth required | - |
integration.recovered | Integration recovered | - |
invoice.paid | Invoice paid | - |
invoice.payment_failed | Invoice payment failed | - |
ivr.activated | Ivr activated | - |
ivr.created | Ivr created | - |
ivr.deactivated | Ivr deactivated | - |
ivr.handed_over | Ivr handed over | - |
ivr.updated | Ivr updated | - |
knowledge.article_drafted | Knowledge article drafted | - |
knowledge.gap_detected | Knowledge gap detected | - |
knowledge.source_synced | Knowledge source synced | - |
lead.created | Lead created | - |
lead.updated | Lead updated | - |
library.item_installed | Library item installed | - |
link_scan.blocked | Link scan blocked | - |
marketing.paused | Marketing paused | - |
marketing.resumed | Marketing resumed | - |
media.provenance_set | Media provenance set | - |
media.ready | Media ready | - |
member.access_changed | Member access changed | - |
member.invited | Member invited | - |
member.joined | Member joined | - |
member.removed | Member removed | - |
member.role_changed | Member role changed | - |
message.failed | Message failed | - |
message.reaction_received | Message reaction received | - |
message.received | Message received | - |
message.sent | Message sent | - |
message.status_updated | Message status updated | yes (+message.status_updated) |
message.updated | Message updated | - |
module.toggled | Module toggled | - |
offer.cancelled | Offer cancelled | - |
offer.completed | Offer completed | - |
offer.confirmed | Offer confirmed | - |
offer.created | Offer created | - |
offer.failed | Offer failed | - |
offer.paused | Offer paused | - |
offer.recipient_status_updated | Offer recipient status updated | yes (+offer.recipient_status_updated) |
offer.resumed | Offer resumed | - |
offer.scheduled | Offer scheduled | - |
offer.started | Offer started | - |
offer.undone | Offer undone | - |
onboarding.updated | Onboarding updated | - |
order.cancelled | Order cancelled | - |
order.cod_confirmed | Order cod confirmed | - |
order.cod_converted | Order cod converted | - |
order.cod_declined | Order cod declined | - |
order.cod_expired | Order cod expired | - |
order.cod_requested | Order cod requested | - |
order.created | Order created | - |
order.paid | Order paid | - |
order.status_changed | Order status changed | - |
order.updated | Order updated | - |
org.closure_requested | Org closure requested | - |
org.created | Org created | - |
org.updated | Org updated | - |
owner.anomaly_detected | Owner anomaly detected | - |
pack.installed | Pack installed | - |
pack.uninstalled | Pack uninstalled | - |
partner.applied | Partner applied | - |
partner.payout_paid | Partner payout paid | - |
partner.payout_requested | Partner payout requested | - |
partner.referral_attributed | Partner referral attributed | - |
payment_link.cancelled | Payment link cancelled | - |
payment_link.created | Payment link created | - |
payment_link.expired | Payment link expired | - |
payment_link.paid | Payment link paid | - |
payment_qr.created | Payment qr created | - |
payment_qr.expired | Payment qr expired | - |
payment.captured | Payment captured | - |
payment.evidence_recorded | Payment evidence recorded | - |
payment.refunded | Payment refunded | - |
payment.to_check | Payment to check | - |
payment.verified | Payment verified | - |
post.created | Post created | - |
post.deleted | Post deleted | - |
post.failed | Post failed | - |
post.published | Post published | - |
post.scheduled | Post scheduled | - |
post.target_updated | Post target updated | - |
product.created | Product created | - |
product.deleted | Product deleted | - |
product.updated | Product updated | - |
review_request.sent | Review request sent | - |
segment.updated | Segment updated | - |
spend.threshold_reached | Spend threshold reached | - |
status.incident_updated | Status incident updated | - |
subscription.activated | Subscription activated | - |
subscription.cancelled | Subscription cancelled | - |
subscription.charged | Subscription charged | - |
subscription.grace_started | Subscription grace started | - |
subscription.past_due | Subscription past due | - |
subscription.recovered | Subscription recovered | - |
subscription.resumed | Subscription resumed | - |
subscription.suspended | Subscription suspended | - |
subscription.trial_ended | Subscription trial ended | - |
subscription.trial_started | Subscription trial started | - |
subscription.updated | Subscription updated | - |
support_request.created | Support request created | - |
support_request.updated | Support request updated | - |
task.completed | Task completed | - |
task.created | Task created | - |
task.overdue | Task overdue | - |
task.updated | Task updated | - |
template.appealed | Template appealed | - |
template.archived | Template archived | - |
template.category_changed | Template category changed | - |
template.created | Template created | - |
template.deleted | Template deleted | - |
template.quality_updated | Template quality updated | - |
template.reinstated | Template reinstated | - |
template.send_failed | Template send failed | - |
template.status_updated | Template status updated | - |
template.submitted | Template submitted | - |
usage.threshold_reached | Usage threshold reached | - |
voice_number.provisioned | Voice number provisioned | - |
voice.room_finished | Voice room finished | yes (+voice.room_finished) |
voice.room_started | Voice room started | yes (+voice.room_started) |
wallet.depleted | Wallet depleted | - |
wallet.low_balance | Wallet low balance | - |
wallet.refunded | Wallet refunded | - |
wallet.topped_up | Wallet topped up | - |
wallet.topup_failed | Wallet topup failed | - |
webhook_endpoint.created | Webhook endpoint created | - |
webhook_endpoint.disabled | Webhook endpoint disabled | - |
widget.chat_started | Widget chat started | - |
workspace.created | Workspace created | - |
workspace.deleted | Workspace deleted | - |
workspace.old_chats_access_changed | Workspace old chats access changed | - |
workspace.updated | Workspace updated | - |
Payload schemas: the webhooks section of docs/api/openapi.json.