Opt-in notification webhook

Get notified of opt-in status changes.

Opt-in status change webhooks are sent whenever the opt-in/out status of a contact's phone number changes. This can happen several ways:

A contact sends an opt-out keyword such as STOP or UNSUBSCRIBE.
A Concierge user manually blocks inbound or outbound messaging for a channel.
A contact sends an opt-in keyword such as START.

Schema


Parameter	Description	Data type
action	Indicates whether the channel is being blocked or unblocked (allowed values — `block` or `unblock`)	string
direction	Indicates whether the block/unblock applies to inbound or outbound messages (allowed values — `inbound` or `outbound`)	string
service_id	The unique ID of the Concierge service	string<uuid>
service_name	The name of the Concierge service	string
contact_id	The unique ID of the contact	string<uuid>
contact_external_id	If the contact was created from or is synced with an external system (such as Oracle Opera, Salesforce, Mindbody, or a custom integration), their ID from the external system will be mapped to the external ID.	string
service_phone	The phone number associated with the Concierge service	string
contact_phone	The phone number of the contact	string
is_auto_blocked	If `true`, the block was initiated by the contact and therefore can only be changed by the contact. If `false`, the block was created by a Concierge user and may be removed by a Concierge user without confirmation from the contact.	boolean

Example payload

{
    "action": "block",
    "direction": "outbound",
    "service_id": "fbb44d67-7437-464d-b249-17e9f918dc8e",
    "service_name": "Star Hotel",
    "contact_id": "f6882aa2-afaf-4230-ae0a-cde79e78afb4",
    "contact_external_id": "9879a777",
    "contact_phone": "+14065551212",
    "service_phone": "+17605558585",
    "is_auto_blocked": true
}