Sign in
User
Webhooks

Register webhook

Registers webhook. If webhook with same ID already exists, it will be replaced

post/3rdparty/v1/webhooks

Request body

deviceIdstring

The unique identifier of the device the webhook is associated with.

event'sms:received' | 'sms:data-received' | 'sms:sent' | 'sms:delivered' | 'sms:failed' | 'sms:cancelled' | 'system:ping' | 'mms:received' | 'mms:downloaded' | 'app:started' | 'sms:batch:received' | 'sms:batch:data-received' | 'mms:batch:received' | 'mms:batch:downloaded' required
idstring

The unique identifier of the webhook.

urlstring required

The URL the webhook will be sent to.

Example request

{
  "deviceId": "PyDmBQZZXYmyxMwED8Fzy",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhook"
}

Response

Created

deviceIdstring

The unique identifier of the device the webhook is associated with.

event'sms:received' | 'sms:data-received' | 'sms:sent' | 'sms:delivered' | 'sms:failed' | 'sms:cancelled' | 'system:ping' | 'mms:received' | 'mms:downloaded' | 'app:started' | 'sms:batch:received' | 'sms:batch:data-received' | 'mms:batch:received' | 'mms:batch:downloaded' required
idstring

The unique identifier of the webhook.

urlstring required

The URL the webhook will be sent to.

Example response

{
  "deviceId": "PyDmBQZZXYmyxMwED8Fzy",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhook"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.