contact.created

Usa contact.created para gestionar este evento en tu endpoint de webhook.

Desencadenadores

Se produce cuando se crea un contacto. Suscríbete a contact.created cuando configures tu endpoint de webhook.

Sintaxis

YCloud envía una solicitud HTTP POST a tu URL de webhook configurada. La siguiente estructura muestra una variante de carga útil. Los valores entre corchetes angulares son marcadores de posición; sus tipos se indican en Parámetros. Los campos opcionales y otras variantes se describen a continuación.

{
  "id": "<ID>",
  "type": "contact.created",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "contactCreated": {
    "id": "<ID>",
    "remarkName": "<REMARK_NAME>",
    "nickName": "<NICK_NAME>",
    "realName": "<REAL_NAME>",
    "phoneNumber": "<PHONE_NUMBER>",
    "countryCode": "<COUNTRY_CODE>",
    "countryName": "<COUNTRY_NAME>",
    "email": "<EMAIL>",
    "sourceType": "<SOURCE_TYPE>",
    "sourceId": "<SOURCE_ID>",
    "sourceUrl": "<SOURCE_URL>",
    "lastSeen": "<LAST_SEEN>",
    "lastConnectedNumber": "<LAST_CONNECTED_NUMBER>",
    "ownerEmail": "<OWNER_EMAIL>",
    "tags": [
      "<TAGS>"
    ],
    "createTime": "<CREATE_TIME>",
    "updateTime": "<UPDATE_TIME>",
    "blocked": "<BLOCKED_VALUE>",
    "customAttributes": {
      "attr1": "<ATTR1>",
      "attr2": "<ATTR2>",
      "attr3": "<ATTR3_VALUE>"
    }
  }
}

Parámetros

Valida el encabezado HTTP YCloud-Signature antes de procesar el cuerpo JSON. Consulta la validación de firmas.

Envoltorio del evento

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	Identificador único del evento. Longitud mínima: `6`. Longitud máxima: `128`.
`type`	string	Sí	Siempre `contact.created`.
`apiVersion`	string	Sí	La versión de la API utilizada para procesar este evento.
`createTime`	string (date-time)	Sí	La fecha y hora en la que se creó este evento, formateada en RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.

Carga útil del evento

Parámetro	Tipo	Obligatorio	Descripción
`contactCreated`	object	No	Carga útil de `contactCreated` específica del evento.

Los cuatro campos comunes del envoltorio son obligatorios. Los campos de la carga útil dependen de la variante del evento. En cada tabla de objetos, Obligatorio se aplica cuando su objeto primario está presente. Los campos opcionales pueden omitirse; un ejemplo no hace que un campo sea obligatorio.

contactCreated

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	Identificador único del objeto.
`remarkName`	string	No	El nombre de observación gestionado por la empresa para el contacto.
`nickName`	string	No	Apodo del contacto.
`realName`	string	No	Nombre real del contacto.
`phoneNumber`	string	No	Número de teléfono único en formato E.164.
`countryCode`	string	No	Abreviatura del país en dos letras. Consulta el código de país ISO 3166-1 alfa-2.
`countryName`	string	No	Nombre completo del país.
`email`	string	No	La dirección de correo electrónico del contacto. Si está presente, la dirección de correo electrónico debe ser única.
`sourceType`	string	No	El tipo de fuente donde se creó el contacto.
`sourceId`	string	No	El identificador de fuente donde se creó el contacto.
`sourceUrl`	string	No	La URL de la fuente donde se creó el contacto.
`lastSeen`	string (date-time)	No	La fecha y hora en la que el contacto envió un mensaje a tu empresa por última vez, formateada en RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.
`lastConnectedNumber`	string	No	El número de teléfono de la empresa al que el contacto se conectó por última vez.
`ownerEmail`	string	No	La dirección de correo electrónico del propietario del contacto.
`tags`	string[]	No	Etiquetas del contacto.
`createTime`	string (date-time)	No	La fecha y hora en la que se creó el contacto, formateada en RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.
`updateTime`	string (date-time)	No	La fecha y hora en la que se actualizó el contacto por última vez, formateada en RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.
`blocked`	boolean	No	Indica si el contacto está bloqueado.
`customAttributes`	object	No	Atributos personalizados del contacto como pares clave-valor.

Ejemplo

El siguiente JSON es el cuerpo entregado a tu receptor. Los IDs, números de teléfono y otros valores de la cuenta son ilustrativos.

Evento de contacto creado

Ejemplo de payload cuando se crea un nuevo contacto

{
  "id": "evt_2345678901",
  "type": "contact.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactCreated": {
    "id": "1824266594102064128",
    "remarkName": "Priority customer",
    "nickName": "John Doe",
    "realName": "John Smith",
    "phoneNumber": "+12025550124",
    "countryCode": "US",
    "countryName": "United States",
    "email": "recipient@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": {
      "attr1": "value1",
      "attr2": "value2",
      "attr3": 123
    }
  }
}

Ejemplo de contacto creado

{
  "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": "+12025550124",
    "countryCode": "US",
    "countryName": "United States",
    "email": "recipient@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
    }
  }
}

Tras verificar la firma y aceptar el evento de forma duradera, devuelve una respuesta 2xx. Procesa el trabajo lento de forma asíncrona.

HTTP/1.1 200 OK

Para ver tutoriales paso a paso de situaciones prácticas, consulta los ejemplos anotados.

Primeros pasos

Guías

Endpoints

Webhook reference

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Carga útil del evento

contactCreated

Ejemplo

​Desencadenadores

​Sintaxis

​Parámetros

​Envoltorio del evento

​Carga útil del evento

​contactCreated

​Ejemplo

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Carga útil del evento

contactCreated

Ejemplo