Webhook de Inscrição de Telefone

POST

Acionado quando um número de telefone se inscreve através do envio de formulário

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

Versão da estrutura de dados do webhook de notificação

string

name

Nome do evento do Webhook

string

created_at

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

integer

attempt_total

Número total de tentativas de entrega de webhooks de notificação

integer

>= 1 <= 4

attempt_number

Número atual da tentativa de notificação do webhook

integer

>= 1

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: phone.subscribe

data

Phone subscribe webhook data payload

object

phone

required

Número de telefone que se inscreveu

string

user_id

required

ID do usuário associado ao número de telefone

integer

created_at

required

Unix timestamp when the subscribe occurred

integer

campaign_code

required

Código da campanha associado à inscrição

string

additional_data

required

Dados adicionais relacionados ao evento de inscrição

Array<object>

object

short_link_code

required

Código do link curto associado à inscrição

string

group_id

required

ID do grupo associado à inscrição do telefone

integer

timestamp

Timestamp Unix quando a inscrição ocorreu

Examples

Example subscribe

Evento de inscrição de telefone

{
  "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 recebido

400

Estrutura do corpo do pedido de webhook inválido

401

Pedido de webhook não autorizado

403

Acesso proibido ao webhook

404

Acesso proibido ao webhook

500

Erro do servidor