Gets a specific event template for your app

Obter um modelo de evento

curl --request GET \
  --url 'https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}?hapikey='

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "name": "petType",
      "label": "Pet Type",
      "type": "enumeration",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "objectPropertyName": "customPropertyPetType",
      "options": [
        {
          "value": "dog",
          "label": "Dog"
        },
        {
          "value": "cat",
          "label": "Cat"
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "detailTemplate": "<string>",
  "headerTemplate": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

GET

integrators

timeline

{appId}

event-templates

{eventTemplateId}

Obter um modelo de evento

curl --request GET \
  --url 'https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}?hapikey='

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "name": "petType",
      "label": "Pet Type",
      "type": "enumeration",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "objectPropertyName": "customPropertyPetType",
      "options": [
        {
          "value": "dog",
          "label": "Dog"
        },
        {
          "value": "cat",
          "label": "Cat"
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "detailTemplate": "<string>",
  "headerTemplate": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing HubGrátis

Sales HubGrátis

Service HubGrátis

Content HubStarter

Authorizations

hapikey

string

query

required

Path Parameters

appId

integer<int32>

required

O ID do aplicativo de destino.

eventTemplateId

string

required

O ID do modelo do evento.

Response

successful operation

The current state of the template definition.

string

required

O ID do modelo.

name

string

required

O nome 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.

tokens

object[]

required

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

Mostrar atributos filhos

tokens.label

string

required

Usado para segmentação de listas e relatórios.

tokens.name

string

required

O nome do token referenciado nos modelos. Deve ser exclusivo para o modelo específico. Pode conter apenas caracteres alfanuméricos, pontos, traços ou sublinhados (. - _).

tokens.type

enum<string>

required

O tipo de dados do token. Atualmente, você pode escolher entre [string, número, data, enumeração].

Opções disponíveis:

date,

enumeration,

number,

string

tokens.createdAt

string<date-time>

A data e hora em que o Token do 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.

tokens.objectPropertyName

string

O nome da propriedade do objeto do CRM. Isso irá preencher a propriedade do objeto do CRM associada ao evento. Com uma quantidade suficiente de nomes, você pode construir completamente objetos do CRM utilizando a API de linha do tempo.

tokens.options

object[]

Se o tipo for "enumeration", devemos ter uma lista de opções para escolher.

Mostrar atributos filhos

tokens.options.label

string

required

O rótulo da opção exibido na interface do usuário.

tokens.options.value

string

required

O valor da opção fornecido na ocorrência.

tokens.updatedAt

string<date-time>

A data e hora em que o Token do 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.

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.

Last modified on October 8, 2025

List all event templates for your app

Create an event template for your app

⌘I

Extensão de chamada

Extensão de videoconferência

Linha do tempo

Gets a specific event template for your app

Authorizations

Path Parameters

Response