Exemplos de Webhook de Contato Criado

Para consultar o catálogo completo derivado do esquema, veja todos os exemplos.

O que é

Processe eventos de criação de contato.

Antes de começar

Crie um endpoint HTTPS público em sua aplicação.
Configure um endpoint de webhook da YCloud para os tipos de evento de que você precisa.
Armazene o segredo de assinatura do endpoint com segurança.
Torne o processamento de eventos idempotente.

Como funciona

A YCloud envia uma requisição HTTP POST quando o evento ocorre. Verifique a assinatura, registre o evento de forma durável, retorne uma resposta 2xx e processe tarefas lentas de forma assíncrona.

Requisição

Os cenários abaixo mostram requisições entregues ao seu URL de webhook. Trate o id do evento como o identificador de entrega e use type para rotear o payload.

Resposta

Retorne um status 2xx após aceitar o evento.

HTTP/1.1 200 OK

Para configuração de endpoint, validação de assinatura e comportamento de repetição, consulte Configurar webhooks.

Ocorre quando um novo contato é criado. O payload do webhook contém todas as informações do contato que foi criado.

Exemplo de Contato Criado

Requisição

{
  "id": "evt_2345678901",
  "type": "contact.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactCreated": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "realName": "John Smith",
    "phoneNumber": "+16315551111",
    "countryCode": "US",
    "countryName": "United States",
    "email": "john.doe@example.com",
    "sourceType": "api",
    "sourceId": "import_batch_123",
    "sourceUrl": "https://example.com/signup",
    "lastSeen": "2024-01-01T11:59:00.000Z",
    "lastConnectedNumber": "+16315552222",
    "ownerEmail": "owner@example.com",
    "tags": [
      "premium",
      "newsletter"
    ],
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "blocked": false,
    "customAttributes": {
      "company": "YCloud Inc",
      "age": 25
    }
  }
}

Resposta

Confirme o recebimento da entrega após aceitar o evento de forma durável.

HTTP/1.1 200 OK

Explicação

Informações completas do contato: o objeto contactCreated contém todas as informações disponíveis do contato no momento da criação.
Atributos personalizados: o campo customAttributes contém quaisquer dados personalizados associados ao contato.
Tags: o array tags contém quaisquer tags atribuídas ao contato durante a criação.

Primeiros passos

Guias

Endpoints

Webhooks

Exemplos de Webhook de Contato Criado

O que é

Antes de começar

Como funciona

Requisição

Resposta

Exemplo de Contato Criado

Requisição

Resposta

Explicação

​O que é

​Antes de começar

​Como funciona

​Requisição

​Resposta

​Exemplo de Contato Criado

​Requisição

​Resposta

​Explicação

O que é

Antes de começar

Como funciona

Requisição

Resposta

Exemplo de Contato Criado

Requisição

Resposta

Explicação