Zum Hauptinhalt springen
POST
/
integrators
/
timeline
/
v3
/
{appId}
/
event-templates
Criar um modelo de evento
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"
        }
      ]
    }
  ]
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

O ID do aplicativo de destino.

Body

application/json

The new event template definition.

State of the template definition being created.

​
name
string
required

O nome do modelo.

Example:

"PetSpot Registration"

​
tokens
object[]
required

Uma coleção de tokens que podem ser usados como propriedades personalizadas no evento e para criar objetos de 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

O tipo de objeto do CRM para o qual este modelo é destinado. [Contatos, empresas, tickets e negócios] são suportados.

Example:

"contacts"

​
detailTemplate
string

Usa a sintaxe Markdown com Handlebars e dados específicos do evento para renderizar o HTML em uma linha do tempo quando você expande os detalhes.

Example:

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

​
headerTemplate
string

Usa a sintaxe Markdown com Handlebars e dados específicos do evento para renderizar o HTML em uma linha do tempo como cabeçalho.

Example:

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

Response

successful operation

The current state of the template definition.

​
name
string
required

O nome do modelo.

​
tokens
object[]
required

Uma coleção de tokens que podem ser usados como propriedades personalizadas no evento e para criar objetos de CRM completos.

​
id
string
required

O ID do modelo.

​
objectType
string
required

O tipo de objeto do CRM para o qual este modelo é destinado. [Contatos, empresas, tickets e negócios] são suportados.

​
createdAt
string<date-time>

A data e hora em que o Modelo de evento foi criado, como um registro de data e hora ISO 8601. Será nulo se o modelo foi criado antes de 18 de fevereiro de 2020.

​
detailTemplate
string

Usa a sintaxe Markdown com Handlebars e dados específicos do evento para renderizar o HTML em uma linha do tempo quando você expande os detalhes.

​
headerTemplate
string

Usa a sintaxe Markdown com Handlebars e dados específicos do evento para renderizar o HTML em uma linha do tempo como cabeçalho.

​
updatedAt
string<date-time>

A data e hora em que o Modelo de evento foi atualizado pela última vez, como um registro de data e hora ISO 8601. Será nulo se o modelo foi criado antes de 18 de fevereiro de 2020.

⌘I