Ejemplos de Webhook para creación de contactos y notas

Para consultar el catálogo exhaustivo derivado del esquema, consulta todos los ejemplos.

Qué es

Gestiona eventos contact.created e contact.note.created.

Antes de empezar

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

YCloud envía una solicitud HTTP POST cuando ocurre el evento. Verifica la firma, registra el evento de forma duradera, devuelve una respuesta 2xx y procesa las tareas lentas de forma asíncrona.

Solicitud

Los escenarios a continuación muestran solicitudes enviadas a la URL de tu Webhook. Trata el id del evento como el identificador de entrega y usa type para enrutar el payload.

Respuesta

Devuelve un estado 2xx tras aceptar el evento.

HTTP/1.1 200 OK

Para la configuración del endpoint, la validación de firmas y el comportamiento de reintentos, consulta Configurar webhooks.

Ocurre cuando se crea un nuevo contacto. El payload del Webhook contiene toda la información del contacto creado.

Ejemplo de contacto creado

Solicitud

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

Respuesta

Confirma la entrega tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Información completa del contacto: El objeto contactCreated contiene toda la información de contacto disponible en el momento de la creación.
Atributos personalizados: El campo customAttributes contiene cualquier dato personalizado asociado con el contacto.
Etiquetas: El array tags contiene cualquier etiqueta asignada al contacto durante la creación.

Nota de contacto creada

Usa contact.note.created cuando se cree una nota de contacto.

Solicitud

{
  "id": "evt_1234567890abcdef12345678",
  "type": "contact.note.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+16315551111",
    "content": "Customer prefers follow-up in the morning.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Respuesta

Confirma la entrega tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Usa contactNote.id para identificar la nota y contactId para identificar el contacto al que pertenece. username e phoneNumber describen el contacto y pueden ser null. El payload contiene la instantánea de la nota visible para el cliente, incluido content, sin identificadores internos del operador.

Primeros pasos

Guías

Endpoints

Webhooks

Ejemplos de Webhook para creación de contactos y notas

Qué es

Antes de empezar

Cómo funciona

Solicitud

Respuesta

Ejemplo de contacto creado

Solicitud

Respuesta

Explicación

Nota de contacto creada

Solicitud

Respuesta

Explicación

​Qué es

​Antes de empezar

​Cómo funciona

​Solicitud

​Respuesta

​Ejemplo de contacto creado

​Solicitud

​Respuesta

​Explicación

​Nota de contacto creada

​Solicitud

​Respuesta

​Explicación

Qué es

Antes de empezar

Cómo funciona

Solicitud

Respuesta

Ejemplo de contacto creado

Solicitud

Respuesta

Explicación

Nota de contacto creada

Solicitud

Respuesta

Explicación