Skip to content

WebhookNewSmsPayload

NEW_SMS webhook payload. Sent to your webhook url endpoint via HTTP POST when an sms is received by the phone number that your webhook is attached to. Use the SMS ID to fetch the full SMS details.

Properties

Name Type Description Notes
messageId String Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
webhookId UUID ID of webhook entity being triggered
eventName EventNameEnum Name of the event type webhook is being triggered for.
webhookName String Name of the webhook being triggered [optional]
smsId UUID ID of SMS message
userId UUID User ID of event
phoneNumber UUID ID of phone number receiving SMS
toNumber String Recipient phone number
fromNumber String Sender phone number
body String SMS message body
read Boolean SMS has been read

Enum: EventNameEnum

Name Value
EMAIL_RECEIVED "EMAIL_RECEIVED"
NEW_EMAIL "NEW_EMAIL"
NEW_CONTACT "NEW_CONTACT"
NEW_ATTACHMENT "NEW_ATTACHMENT"
EMAIL_OPENED "EMAIL_OPENED"
EMAIL_READ "EMAIL_READ"
DELIVERY_STATUS "DELIVERY_STATUS"
BOUNCE "BOUNCE"
BOUNCE_RECIPIENT "BOUNCE_RECIPIENT"
NEW_SMS "NEW_SMS"