For AI agents: visit https://docs.delivyr.net/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Webhook Variables Dictionary
| Variable | Type / meaning |
|---|
id | string — Receipt ID |
epoch | number — Unix timestamp |
account_id | string — Account ID |
destination | string — Destination phone number |
message_log_id | string — Message log ID |
request_id | string — Request ID |
source | string — Source number |
status | string — Status |
status_mapped | string — 200=delivered, 110=undeliverable, 120=expired, 500=rejected |
dml | string — "INSERT" |
| Variable | Type / meaning |
|---|
id | string — Incoming message ID |
from | string — Sender phone number |
account_id | string — Account ID |
body | string — Incoming message body |
epoch | number — Unix timestamp |
message_log_id | string — Message log ID |
request_id | string — Request ID |
to | string — Destination phone number |
| Variable | Type / meaning |
|---|
id | string — Message log ID |
account_id | string — Account ID |
body | string — Message body |
dba | string — Doing business as name |
epoch | number — Unix timestamp |
external_id | string — External tracking ID |
journey | string — Journey identifier |
phone_number | string — Destination phone number |
request_id | string — Request ID |
sending_number | string — Sending phone number |
template_id | string — Template ID |
url | string — Tracking URL associated with the message |
category | string — Message category (e.g. sms, mms) |
image_url | string — URL of an image associated with an MMS |
testing | boolean — Whether the message was sent in testing mode |
segments | number — SMS segment count |
dml | string — "INSERT" |
| Variable | Type / meaning |
|---|
id | string — Rejected message ID |
account_id | string — Account ID |
epoch | number — Unix timestamp |
phone_number | string — Phone number |
request | string — JSON string with template_id, phone_number, url, request_id, testing |
rejection_code | decimal — Rejection code |
rejection_reason | string — Human-readable rejection reason |
request_id | string — Request ID (if available) |
dml | string — "INSERT" |
| Variable | Type / meaning |
|---|
id | string — Event log ID |
epoch | number — Unix timestamp |
event | string — "click", "preview", "pin_success", "pin_failure", "view_passkey", "view_reset_pin", "passkey_success" |
ip_address | string — IP address |
message_log_id | string — Message log ID |
account_id | string — Account ID |
request_id | string — Request ID (if available) |
origin | string — Origin URL |
referer | string — Referer URL |
sec-ch-ua | string — Browser client hints |
sec-ch-ua-platform | string — Platform info |
user-agent | string — User agent |
sec-ch-ua-mobile | string — Mobile indicator |
accept-language | string — Accept language |
journey | string — Journey identifier |
dml | string — "INSERT" |
| Variable | Type / meaning |
|---|
phone_number | string — Phone number that opted out |
system_number | string — System number |
epoch | number — Unix timestamp |
account_id | string — Account ID |
incoming_log_id | string — Incoming log ID |
message_log_id | string — Message log ID (if available) |
request_id | string — Request ID (if available) |
dml | string — "INSERT" for new opt-outs, "REMOVE" for removed opt-outs |
| Variable | Type / meaning |
|---|
id | string — Template identifier (UUID) |
id_int | number — Integer representation of id in base 36 |
body | string — Message body with placeholders (e.g. {{name}}) |
title | string — Template name/title |
tags | array — Template tags for filtering |
account_id | string — Account identifier |
category | string — Template category |
status | string — Template status |
image_url | string — URL of an image associated with the template |
url | string — URL associated with the template |
external_type | string — Third-party service type (e.g. optimove) |
external_id | string — External identifier in the third-party system |
dml | string — "INSERT" / "MODIFY" / "REMOVE" |
