Webhook Events
SMS registration action required event
An SMS registration is waiting on its owner; reason says why.
Reasons
- changes_requested: answer message via POST /v1/sms/registrations/{id}/respond.
- otp_required: submit the texted code via POST /v1/sms/registrations/{id}/verify-otp; no message.
- carrier_info_required: expires after 7 days.
When it fires
Fires once per new request and once per OTP or carrier request, not on follow-up messages. A carrier rejection alone does not fire it.
postWebhooksms.registration.action_required
Payload
Example payload
{
"profiles": [
{
"externalId": "tenant_42"
}
]
}Response
Webhook received successfully
Changes
Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.