Skip to main content

GenericWebhookPayload

Normalised delivery receipt, covering the fields Nerve extracts from every provider's own webhook body.

channelstring | nullnullable

Channel the message went out on.

Example: sms
cost(number | null)<float>nullable

Provider-reported cost in USD.

Example: 0.002
latency_ms(integer | null)<int32>nullable

Provider-reported end-to-end latency in milliseconds.

Possible values: >= 0

Example: 120
message_idstring | nullnullable

The provider's own identifier for the message.

Example: SM3f8a1c9b
recipientstring | nullnullable

Address or token the message was sent to.

Example: +2348012345678
statusstring | nullnullable

Delivery state: one of TRIGGERED, QUEUED, SENT, DELIVERED, SEEN, CLICKED, BOUNCED_HARD, BOUNCED_SOFT, COMPLAINED.

Example: DELIVERED
GenericWebhookPayload
{
"channel": "sms",
"cost": 0.002,
"latency_ms": 120,
"message_id": "SM3f8a1c9b",
"recipient": "+2348012345678",
"status": "DELIVERED"
}