Create an event template

Las plantillas de eventos definen la estructura general de un evento de cronología personalizado y te permiten enviar datos de eventos a HubSpot. Una plantilla incluye una copia formateada para su encabezado y detalles, así como cualquier definición de propiedad personalizada. Una sola aplicación puede incluir hasta 750 plantillas de eventos.

las API de eventos de cronología v1 y v3 solo están disponibles para socios de aplicaciones con eventos de cronología v1/v3 definidos en su aplicación pública.

• Si tu aplicación aún no incluye ningún evento de cronología, las solicitudes a este punto de terminación fallarán. En su lugar, puedes empezar en última versión de la plataforma para desarrolladores. Recuerda que tendrás que solicitar aprobación antes de poder definir eventos de aplicación para tu aplicación. Más información en la descripción general de los eventos de aplicación.
• Si tu aplicación incluye un evento de cronología v1/v3, aprende a migrarlo a la plataforma para desarrolladores. No es necesario solicitar la aprobación antes de migrar los tipos de eventos existentes.

Si no eres un App Partner, puedes enviar datos de eventos personalizados a HubSpot utilizando la API de eventos personalizados.

POST /integrators/timeline/v3/{appId}/event-templates

Crear una plantilla de evento

cURL

curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "detailTemplate": "<string>",
  "headerTemplate": "<string>"
}
'

201

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "detailTemplate": "<string>",
  "headerTemplate": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

Autorizaciones

Authorization · string · header · requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

appId · integer<int32> · requerido

El ID de la aplicación de destino.

Cuerpo

application/json

name · string · requerido

El nombre de la plantilla.

objectType · string · requerido

El tipo de objeto del CRM para el que está diseñada esta plantilla. [Se admiten contactos, empresas, tickets y negocios].

tokens · object[] · requerido

Una colección de tokens que se pueden utilizar como propiedades personalizadas en el evento y para crear objetos del CRM completos.

Show child attributes

detailTemplate · string

Esto utiliza la sintaxis Markdown con Handlebars y datos específicos del evento para renderizar HTML en una cronología cuando expandes los detalles.

headerTemplate · string

Esto utiliza la sintaxis Markdown con Handlebars y datos específicos del evento para renderizar HTML en una cronología como un encabezado.

Respuesta

201

application/json

successful operation

id · string · requerido

El ID de la plantilla.

name · string · requerido

El nombre de la plantilla.

objectType · string · requerido

El tipo de objeto del CRM para el que está diseñada esta plantilla. [Se admiten contactos, empresas, tickets y negocios].

tokens · object[] · requerido

Una colección de tokens que se pueden utilizar como propiedades personalizadas en el evento y para crear objetos del CRM completos.

Show child attributes

createdAt · string<date-time>

La fecha y hora en que se creó la plantilla de evento, como una marca de tiempo ISO 8601. Será nulo si la plantilla se creó antes del 18 de febrero de 2020.

detailTemplate · string

Esto utiliza la sintaxis Markdown con Handlebars y datos específicos del evento para renderizar HTML en una cronología cuando expandes los detalles.

headerTemplate · string

Esto utiliza la sintaxis Markdown con Handlebars y datos específicos del evento para renderizar HTML en una cronología como un encabezado.

updatedAt · string<date-time>

La fecha y hora en que se actualizó por última vez la plantilla de evento, como una marca de tiempo ISO 8601. Será nulo si la plantilla se creó antes del 18 de febrero de 2020.