Delivery Webhooks (DLR)

Create webhook

Message events POST one payload shape regardless of where in the pipeline the state change happened: { "id", "to", "channel", "status", "error_code", "error_message" } — the two error fields are present only on failed/undeliverable events and carry the same values as the stored message (see the Message schema). id is the EnvoiSMS message id, the same one the send call returned. metadata supplied at send time is included on delivery-report events.

post/webhooks

Request

  • Base URL: https://api.envoisms.ma/v1
  • URL: https://api.envoisms.ma/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsstring[]
secretstring

Optional HMAC secret. Generated and returned when omitted.

Example request

{
  "url": "https://yourapp.com/smsma-webhook"
}

Response

Webhook created

Changes

No recorded changes to this operation across all 1 revision of this API.