Verify Code Channel Sent

POST

The event verify_code.channel.sent is triggered when the verification code has been dispatched through a specific channel.

Webhook notifications

Authorizations

• token

Request Body ^required

Media type application/json

object

id

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

api_version

Version of the notification webhook data structure

string

name

Webhook’s event name

string

created_at

Timestamp when the entity was added to the system by the user

integer

attempt_total

Total number of notification webhook delivery attempts

integer

>= 1 <= 4

attempt_number

Current webhook notification attempt number

integer

>= 1

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: verify_code.channel.sent

data

Data for verify_code.channel.sent, verify_code.channel.success and verify_code.channel.failed events

object

id

Verify code ID (UUID)

string

user_id

User ID

integer

phone

Phone number

string

routing_strategy

Routing strategy configuration

Array<object>

object

channel

string

Allowed values: telegram sms

timeout_sec

Timeout in seconds. Only applicable for the telegram channel.

integer

sender_id

string

status

Verify code status

integer

delivered_channel

Channel that delivered the code

string | null

cost

Cost in cents

integer | null

currency

Currency code

string | null

code

Verification code

string | null

code_length

Code length

integer | null

payload

Custom payload

string | null

created_at

Creation timestamp

integer

updated_at

Last update timestamp

integer

history

Processing history

Array<object>

object

id

string

channel

string

status

integer

processed_at

integer

external_id

string

is_code_deleted

Whether the verification code has been deleted from storage after being sent.

boolean

channel

Channel-specific processing details

object

id

History entry ID

string

channel

Channel type

string

Allowed values: telegram sms

status

Channel processing status

integer

processed_at

Processing timestamp

integer

external_id

External provider ID

string | null

error

Error message if failed

string | null

cost

Cost for this channel in cents

integer | null

Examples

Example sent

Verify Code Channel Sent Event

Event sent when the verification code was dispatched through a specific channel

{
  "id": "d04b2f3e-5c6d-4d7b-9f8a-0e1b2c3d4e5f",
  "api_version": "2022-05-25",
  "name": "verify_code.channel.sent",
  "created_at": 1735689555,
  "attempt_total": 3,
  "attempt_number": 1,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "user_id": 12345,
    "phone": "+4915112345678",
    "routing_strategy": [
      {
        "channel": "telegram",
        "timeout_sec": 30,
        "sender_id": "LOX24"
      },
      {
        "channel": "sms",
        "timeout_sec": 60,
        "sender_id": "LOX24"
      }
    ],
    "status": 5,
    "delivered_channel": null,
    "cost": 5,
    "currency": "EUR",
    "code": "1234",
    "code_length": 4,
    "payload": "session_abc123",
    "created_at": 1735689540,
    "updated_at": 1735689555,
    "history": [
      {
        "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890",
        "channel": "telegram",
        "status": 10,
        "processed_at": 1735689555,
        "external_id": "tg_msg_001"
      }
    ],
    "is_code_deleted": false,
    "channel": {
      "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890",
      "channel": "telegram",
      "status": 10,
      "processed_at": 1735689555,
      "external_id": "tg_msg_001",
      "error": null,
      "cost": 5
    }
  },
  "notification_task_id": "55baf095-fa88-6fa9-1f4b-4d32e63dd863"
}

Responses

200

Webhook received

400

Invalid webhook request’s body structure

401

Webhook request unauthorized

403

Webhook access forbidden

404

Webhook access forbidden

500

Server error