Skip to main content

Opt-out webhook

SIGNOFF: Triggered when a recipient opts out of receiving further SMS messages by sending a "STOP" keyword.

Subscribe with Subscribe to webhooks, using the type SIGNOFF.

The payload​

{
"message_id": "12345",
"from": "46701740609",
"to": "46701740610",
"keyword": "STOPP",
"timestamp": 1739710713,
"action": "SIGNOFF"
}
  • message_id: A unique ID for the sign-off event.
  • from: The phone number of the user who opted out.
  • to: The recipient's phone number.
  • keyword: The keyword field typically contains STOPP or STOP to indicate a recipient opting out of messages. However, it may vary if a custom shortcode is used for opt-out.
  • timestamp: The time of the sign-off event as a UNIX timestamp.
  • action: The action that triggered the webhook.