Interface: 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.
export
interface
WebhookNewSmsPayload
Table of contents
Properties
Properties
body
• body: string
SMS message body
memberof
WebhookNewSmsPayload
eventName
• eventName: WebhookNewSmsPayloadEventNameEnum
Name of the event type webhook is being triggered for.
memberof
WebhookNewSmsPayload
fromNumber
• fromNumber: string
Sender phone number
memberof
WebhookNewSmsPayload
messageId
• messageId: string
Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
memberof
WebhookNewSmsPayload
phoneNumber
• phoneNumber: string
ID of phone number receiving SMS
memberof
WebhookNewSmsPayload
read
• read: boolean
SMS has been read
memberof
WebhookNewSmsPayload
smsId
• smsId: string
ID of SMS message
memberof
WebhookNewSmsPayload
toNumber
• toNumber: string
Recipient phone number
memberof
WebhookNewSmsPayload
userId
• userId: string
User ID of event
memberof
WebhookNewSmsPayload
webhookId
• webhookId: string
ID of webhook entity being triggered
memberof
WebhookNewSmsPayload
webhookName
• Optional
webhookName: string
Name of the webhook being triggered
memberof
WebhookNewSmsPayload