The message.delivered event is delivered whenever a message sent from a Surge number is successfully delivered to the recipient. When the message is sent from a short code or toll-free number, this means that the message arrived on the recipient's device. When sent from a local number, this means that the message was successfully handed off to the recipient's mobile carrier, but does not guarantee that it arrived on the recipient's device.
postWebhookmessageDelivered
Payload
Example payload
{
"account_id": "acct_01japd271aeatb7txrzr2xj8sg",
"data": {
"attachments": [
{
"id": "att_01jjnn75vgepj8bnnttfw1st5s",
"type": "image",
"url": "https://toretto.family/skyline.jpg"
}
],
"blast_id": null,
"body": "Dude, I almost had you!",
"conversation": {
"contact": {
"email": "dom@toretto.family",
"first_name": "Dominic",
"id": "ctc_01ja88cboqffhswjx8zbak3ykk",
"last_name": "Toretto",
"metadata": {
"car": "1970 Dodge Charger R/T"
},
"phone_number": "+18015551234"
},
"id": "cnv_01jav8xy7fe4nsay3c9deqxge9",
"phone_number": {
"campaign_id": "cpn_01jjnn7s0zfx5tdcsxjfy93et2",
"id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
"name": "(801) 555-6789",
"number": "+18015556789",
"type": "local"
}
},
"delivered_at": "2024-10-21T23:29:42Z",
"id": "msg_01jjnn7s0zfx5tdcsxjfy93et2",
"metadata": {
"order_id": "12345"
}
},
"timestamp": "2024-10-21T23:29:41Z",
"type": "message.delivered"
}Response
Return a 200 status to indicate that the data was received successfully