Fired once for every new SMS on an API-bought rental or dedicated number, with or without a detected code. A coded message fires this first, then rental.code_received. An SMS received while a renewal is unpaid arrives with text and code null and content_withheld true.
postWebhookrental.message_received
Payload
Example payload
{
"id": "evt_01HXYZ123456789ABCDEFG",
"data": {
"rental": {
"id": "ren_01HXYZ123ABC",
"display_id": "SMS7K4P2N",
"phone_number": "+15551234567",
"service_id": "svc_telegram",
"service_name": "Telegram",
"country": "us",
"duration": "7D",
"charged_price_cents": 2500,
"next_renewal_price_cents": 2500,
"payment_due": {
"amount_cents": 1499
},
"re_rent_available": true,
"re_rent_price_cents": 2500,
"messages": [
{
"id": "msg_01HXYZ123ABC",
"code": "123456",
"text": "Your verification code is 123456."
}
]
},
"message": {
"id": "msg_01HXYZ789GHI",
"text": "Your account was accessed from a new device."
}
}
}Response
Acknowledged.
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.