Passer au contenu principal
POST
/
integrators
/
timeline
/
v3
/
{appId}
/
event-templates
Créer un modèle d'événement
curl --request POST \
  --url 'https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates?hapikey=' \
  --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"
        }
      ]
    }
  ]
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubStarter

Autorisations

hapikey
string
query
requis

Paramètres de chemin

appId
integer<int32>
requis

L'ID de l'application cible.

Corps

application/json

The new event template definition.

State of the template definition being created.

name
string
requis

Le nom du modèle.

objectType
string
requis

Le type d'objet du CRM pour lequel ce modèle est conçu. [Contacts, entreprises, tickets et transactions] sont pris en charge.

tokens
object[]
requis

Une collection de jetons pouvant être utilisés comme propriétés personnalisées sur l'événement et pour créer des objets CRM à part entière.

detailTemplate
string

Ceci utilise la syntaxe Markdown avec Handlebars et des données spécifiques à un événement pour générer du HTML sur une chronologie lorsque vous développez les détails.

headerTemplate
string

Ceci utilise la syntaxe Markdown avec Handlebars et des données spécifiques à un événement pour afficher du HTML sur une chronologie comme un en-tête.

Réponse

successful operation

The current state of the template definition.

id
string
requis

L'ID du modèle.

name
string
requis

Le nom du modèle.

objectType
string
requis

Le type d'objet du CRM pour lequel ce modèle est conçu. [Contacts, entreprises, tickets et transactions] sont pris en charge.

tokens
object[]
requis

Une collection de jetons pouvant être utilisés comme propriétés personnalisées sur l'événement et pour créer des objets CRM à part entière.

createdAt
string<date-time>

La date et l'heure de création du modèle d'événement, sous la forme d'un horodatage ISO 8601. Sera nul si le modèle a été créé avant le 18 février 2020.

detailTemplate
string

Ceci utilise la syntaxe Markdown avec Handlebars et des données spécifiques à un événement pour générer du HTML sur une chronologie lorsque vous développez les détails.

headerTemplate
string

Ceci utilise la syntaxe Markdown avec Handlebars et des données spécifiques à un événement pour afficher du HTML sur une chronologie comme un en-tête.

updatedAt
string<date-time>

La date et l'heure de la dernière mise à jour du modèle d'événement, sous la forme d'un horodatage ISO 8601. Sera nul si le modèle a été créé avant le 18 février 2020.

Last modified on January 23, 2026