Exemplos de webhook para atualização de contato e anotação

​

O que é

​

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 que você precisa.
• Armazene o segredo de assinatura do endpoint com segurança.
• Torne o processamento de eventos idempotente.

​

Como funciona

​

Solicitação

​

Resposta

HTTP/1.1 200 OK

​

Exemplo de alteração de tags (adicionar tags)

​

Solicitação

{
  "id": "evt_1234567892",
  "type": "contact.attributes_changed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactAttributesChanged": {
    "id": "1824266594102064128",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "changedAttributes": {
      "tags": {
        "oldValue": ["premium", "newsletter"],
        "newValue": ["premium", "newsletter", "vip"],
        "extra": [
          {
            "action": "ADDED",
            "id": "686dd294334be8606a5bf312",
            "value": "vip"
          }
        ]
      }
    }
  }
}

​

Resposta

HTTP/1.1 200 OK

​

Explicação

​

Exemplo de alteração de tags (remover tags)

​

Solicitação

{
  "id": "evt_1234567893",
  "type": "contact.attributes_changed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactAttributesChanged": {
    "id": "1824266594102064128",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "changedAttributes": {
      "tags": {
        "oldValue": ["premium", "newsletter", "vip"],
        "newValue": ["premium", "newsletter"],
        "extra": [
          {
            "action": "REMOVED",
            "id": "686dd294334be8606a5bf312",
            "value": "vip"
          }
        ]
      }
    }
  }
}

​

Resposta

HTTP/1.1 200 OK

​

Explicação

​

Exemplo de alteração

​

Solicitação

{
  "id": "evt_1234567900",
  "type": "contact.attributes_changed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactAttributesChanged": {
    "id": "1824266594102064128",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "changedAttributes": {
      "waba_id": {
        "oldValue": "waba_old_123456",
        "newValue": "waba_new_789012",
        "extra": [
          {
            "action": "CHANGED"
          }
        ]
      }
    }
  }
}

​

Resposta

HTTP/1.1 200 OK

​

Explicação

• Estrutura correta: o objeto contactAttributesChanged contém três campos obrigatórios: id, updateTime e changedAttributes.
• Atributos alterados: o campo changedAttributes é um objeto em que cada chave é o nome do atributo e o valor é um objeto ContactAttributeChange.
• Configuração de propriedades do evento: ao habilitar eventos contact.attributes_changed, você deve configurar o campo eventProperties no seu endpoint de webhook para especificar quais atributos devem ser incluídos no payload do webhook.
• Tipos de atributos: os campos oldValue e newValue podem conter diferentes tipos de dados:
  • String: valores de texto
  • Number: valores numéricos (inteiro ou decimal)
  • Boolean: valores verdadeiro/falso
  • Array: matrizes de strings
  • Object: objetos complexos com propriedades aninhadas
  • Null: quando um atributo é removido ou não definido
• Alterações de tags: para atributos de tags, o campo extra fornece informações detalhadas sobre quais tags foram adicionadas ou removidas, incluindo seus IDs e valores.
• Valores nulos: quando um atributo é removido ou definido como nulo, o newValue será null. Quando um atributo é adicionado recentemente, o oldValue pode ser null.
• Atributos personalizados: atributos personalizados são incluídos no objeto changedAttributes da mesma forma que os atributos padrão, com suas chaves personalizadas como os nomes dos atributos.
• Detecção de alterações: somente os atributos que foram efetivamente alterados são incluídos no objeto changedAttributes.
• Campo extra: o campo extra é opcional e é usado principalmente para alterações relacionadas a tags a fim de fornecer contexto adicional sobre as ações específicas realizadas.

​

Anotação de contato atualizada

​

Solicitação

{
  "id": "evt_2234567890abcdef12345678",
  "type": "contact.note.updated",
  "apiVersion": "v2",
  "createTime": "2024-01-02T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+16315551111",
    "content": "Customer now prefers afternoon follow-up.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-02T12:00:00.000Z"
  }
}

​

Resposta

HTTP/1.1 200 OK

​

Explicação