Ejemplos de Webhook para actualizaciones de contactos y notas

​

Qué es

​

Antes de comenzar

• Crea un endpoint HTTPS público en tu aplicación.
• Configura un endpoint de Webhook de YCloud para los tipos de evento que necesites.
• Guarda el secreto de firma del endpoint de forma segura.
• Haz que el procesamiento de eventos sea idempotente.

​

Cómo funciona

​

Solicitud

​

Respuesta

HTTP/1.1 200 OK

​

Ejemplo de cambio de etiquetas (añadir etiquetas)

​

Solicitud

{
  "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"
          }
        ]
      }
    }
  }
}

​

Respuesta

HTTP/1.1 200 OK

​

Explicación

​

Ejemplo de cambio de etiquetas (eliminar etiquetas)

​

Solicitud

{
  "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"
          }
        ]
      }
    }
  }
}

​

Respuesta

HTTP/1.1 200 OK

​

Explicación

​

Ejemplo de cambio

​

Solicitud

{
  "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"
          }
        ]
      }
    }
  }
}

​

Respuesta

HTTP/1.1 200 OK

​

Explicación

• Estructura correcta: El objeto contactAttributesChanged contiene tres campos obligatorios: id, updateTime y changedAttributes.
• Atributos modificados: El campo changedAttributes es un objeto donde cada clave es el nombre del atributo y el valor es un objeto ContactAttributeChange.
• Configuración de propiedades del evento: Al habilitar los eventos contact.attributes_changed, debes configurar el campo eventProperties en el endpoint de tu Webhook para especificar qué atributos deben incluirse en el payload del Webhook.
• Tipos de atributos: Los campos oldValue y newValue pueden contener diferentes tipos de datos:
  • String: valores de texto
  • Number: valores numéricos (enteros o decimales)
  • Boolean: valores booleanos (true/false)
  • Array: arrays de cadenas
  • Object: objetos complejos con propiedades anidadas
  • Null: cuando un atributo se elimina o no está establecido
• Cambios en etiquetas: Para los atributos de etiquetas, el campo extra proporciona información detallada sobre qué etiquetas se agregaron o eliminaron, incluidos sus identificadores y valores.
• Valores nulos: Cuando un atributo se elimina o se establece en null, newValue será null. Cuando se añade un atributo nuevo, oldValue puede ser null.
• Atributos personalizados: Los atributos personalizados se incluyen en el objeto changedAttributes al igual que los atributos estándar, utilizando sus claves personalizadas como nombres de atributo.
• Detección de cambios: Solo se incluyen en el objeto changedAttributes los atributos que realmente hayan cambiado.
• Campo adicional: El campo extra es opcional y se utiliza principalmente para cambios relacionados con etiquetas con el fin de proporcionar contexto adicional sobre las acciones específicas realizadas.

​

Nota de contacto actualizada

​

Solicitud

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

​

Respuesta

HTTP/1.1 200 OK

​

Explicación