Ejemplos de Webhook de contacto creado

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

Qué es

Maneja eventos de creación de contactos.

Antes de comenzar

Crea un endpoint HTTPS público en tu aplicación.
Configura un endpoint de Webhook de YCloud para los tipos de eventos 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 el trabajo lento de forma asíncrona.

Solicitud

Los escenarios a continuación muestran las solicitudes entregadas a tu URL de Webhook. Trata el evento id como el identificador de entrega y utiliza type para enrutar el payload.

Respuesta

Devuelve un estado 2xx después de 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 la información completa del contacto que fue 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.

Primeros pasos

Guías

Endpoints

Webhooks

Ejemplos de Webhook de contacto creado

Qué es

Antes de comenzar

Cómo funciona

Solicitud

Respuesta

Ejemplo de contacto creado

Solicitud

Respuesta

Explicación

​Qué es

​Antes de comenzar

​Cómo funciona

​Solicitud

​Respuesta

​Ejemplo de contacto creado

​Solicitud

​Respuesta

​Explicación

Qué es

Antes de comenzar

Cómo funciona

Solicitud

Respuesta

Ejemplo de contacto creado

Solicitud

Respuesta

Explicación