Skip to main content
POST
/
integrators
/
timeline
/
v3
/
{appId}
/
event-templates
Create an event template
curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "PetSpot Registration",
  "objectType": "contacts",
  "headerTemplate": "Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})",
  "detailTemplate": "Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n  **{{question}}**: {{answer}}\n{{/each}}",
  "tokens": [
    {
      "name": "petName",
      "label": "Pet Name",
      "type": "string"
    },
    {
      "name": "petAge",
      "label": "Pet Age",
      "type": "number"
    },
    {
      "name": "petColor",
      "label": "Pet Color",
      "type": "enumeration",
      "options": [
        {
          "value": "white",
          "label": "White"
        },
        {
          "value": "black",
          "label": "Black"
        },
        {
          "value": "brown",
          "label": "Brown"
        },
        {
          "value": "other",
          "label": "Other"
        }
      ]
    }
  ]
}'
{
  "id": "1001298",
  "objectType": "contacts",
  "createdAt": "2020-02-12T20:58:26Z",
  "updatedAt": "2020-02-12T20:58:26Z",
  "name": "PetSpot Registration",
  "headerTemplate": "Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})",
  "detailTemplate": "Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n  **{{question}}**: {{answer}}\n{{/each}}",
  "tokens": [
    {
      "name": "petName",
      "type": "string",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Name",
      "options": []
    },
    {
      "name": "petAge",
      "type": "number",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Age",
      "options": []
    },
    {
      "name": "petColor",
      "type": "enumeration",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Color",
      "options": [
        {
          "value": "white",
          "label": "White"
        },
        {
          "value": "black",
          "label": "Black"
        },
        {
          "value": "brown",
          "label": "Brown"
        },
        {
          "value": "other",
          "label": "Other"
        }
      ]
    }
  ]
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

El ID de la aplicación de destino.

Body

application/json

The new event template definition.

State of the template definition being created.

​
name
string
required

El nombre de la plantilla.

Example:

"PetSpot Registration"

​
tokens
object[]
required

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

Example:

"[{\"name\":\"petName\",\"type\":\"string\",\"label\":\"Pet Name\"},{\"name\":\"petAge\",\"type\":\"number\",\"label\":\"Pet Age\"},{\"name\":\"petColor\",\"type\":\"enumeration\",\"label\":\"Pet Color\",\"options\":[{\"label\":\"White\",\"value\":\"white\"},{\"label\":\"Black\",\"value\":\"black\"},{\"label\":\"Brown\",\"value\":\"brown\"},{\"label\":\"Other\",\"value\":\"other\"}]}]"

​
objectType
string
required

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

Example:

"contacts"

​
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.

Example:

"Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n **{{question}}**: {{answer}}\n{{/each}}"

​
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.

Example:

"Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})"

Response

successful operation

The current state of the template definition.

​
name
string
required

El nombre de la plantilla.

​
tokens
object[]
required

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

​
id
string
required

El ID de la plantilla.

​
objectType
string
required

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

​
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.

⌘I