Phone Subscribe Webhook

POST

Triggered when a phone number subscribes by form submit

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

data

Event-specific data payload

object

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: phone.subscribe

data

object

phone

required

Phone number that subscribed

string

user_id

required

ID of the user associated with the phone number

integer

created_at

required

Unix timestamp when the subscribe occurred

integer

campaign_code

required

Campaign code associated with the subscribe

string

additional_data

required

Additional data related to the subscribe event

Array

short_link_code

required

Short link code associated with the subscribe

string

group_id

required

ID of the group associated with the phone subscribe

integer

Examples

Example subscribe

Phone subscribe event

{
  "id": "ed18a290-766d-46cf-ab4e-6fa421405fbd",
  "data": {
    "phone": "+99559122567",
    "user_id": 21911,
    "created_at": 1757926648,
    "campaign_code": "1dkGdCC2xnBc",
    "additional_data": [],
    "short_link_code": "baaIoP",
    "group_id": 123
  },
  "name": "phone.subscribe",
  "created_at": 1757926648,
  "api_version": "2022-05-25",
  "attempt_number": 1,
  "attempts_total": 4
}

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