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

Hierarchy

  • WebhookNewSmsPayload

Properties

body eventName fromNumber messageId phoneNumber read smsId toNumber userId webhookId webhookName?

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

Optional webhookName

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookNewSmsPayload

Settings

Member Visibility

Theme