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"
        }
      ]
    }
  ]
}

Modèles

Create an event template for your app

Les modèles d’événement définissent la structure générale d’un événement personnalisé dans la chronologie et vous permettent d’envoyer des données d’événement à HubSpot. Un modèle comprend un texte formaté pour son titre et ses détails, ainsi que toutes les définitions de propriétés personnalisées. Une seule application peut inclure jusqu’à 750 modèles d’événements.

Les API d’événements de chronologie « v1 » et « v3 » ne sont disponibles que pour les partenaires d’application ayant déjà défini des événements de chronologie « v1 »/« v3 » dans leur application publique.

Si votre application ne comprend encore aucun événement de chronologie, les requêtes adressées à ce point de terminaison échoueront. Vous pouvez plutôt commencer à utiliser la dernière version de la plateforme de développement. Notez que vous devrez demander une autorisation avant de pouvoir définir des événements pour votre application. Pour en savoir plus, consultez la présentation des événements d’application.
Si votre application inclut un événement de chronologie « v1 »/« v3 », découvrez comment le migrer vers la plateforme de développement. Vous n’avez pas besoin de demander d’autorisation avant de migrer les types d’événements existants.

Si vous n’êtes pas un partenaire d’application, vous pouvez envoyer des données d’événements personnalisés à HubSpot à l’aide de l’API des événements personnalisés.

POST

integrators

timeline

{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 HubGratuit

Sales HubGratuit

Service HubGratuit

Content HubStarter

Authorizations

hapikey

string

query

required

Path Parameters

appId

integer<int32>

required

L'ID de l'application cible.

Body

application/json

The new event template definition.

State of the template definition being created.

name

string

required

Le nom du modèle.

objectType

string

required

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[]

required

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.

Afficher attributs enfants

tokens.label

string

required

Utilisé pour la segmentation de listes et le reporting.

tokens.name

string

required

Le nom du jeton référencé dans les modèles. Il doit être unique pour le modèle spécifique. Il ne peut contenir que des caractères alphanumériques, des points, des tirets ou des tirets bas (. - _).

tokens.type

enum<string>

required

Le type de données du jeton. Vous pouvez actuellement choisir parmi [chaîne, nombre, date, énumération].

Options disponibles:

date,

enumeration,

number,

string

tokens.createdAt

string<date-time>

La date et l'heure de création du jeton de 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.

tokens.objectPropertyName

string

Le nom de la propriété d'objet du CRM. Cela remplira la propriété d'objet du CRM associée à l'événement. Avec suffisamment de ces éléments, vous pouvez construire entièrement des objets CRM via l'API de chronologie.

tokens.options

object[]

Si le type est enumeration, nous devrions avoir une liste d'options parmi lesquelles choisir.

Afficher attributs enfants

tokens.options.label

string

required

Le libellé de l'option qui s'affiche en avant-plan.

tokens.options.value

string

required

La valeur de l'option fournie lors de l'événement.

tokens.updatedAt

string<date-time>

La date et l'heure de la dernière mise à jour du jeton de 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.

Response

successful operation

The current state of the template definition.

string

required

L'ID du modèle.

name

string

required

Le nom du modèle.

objectType

string

required

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[]

required

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.

Afficher attributs enfants

tokens.label

string

required

Utilisé pour la segmentation de listes et le reporting.

tokens.name

string

required

tokens.type

enum<string>

required

Le type de données du jeton. Vous pouvez actuellement choisir parmi [chaîne, nombre, date, énumération].

Options disponibles:

date,

enumeration,

number,

string

tokens.createdAt

string<date-time>

La date et l'heure de création du jeton de 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.

tokens.objectPropertyName

string

tokens.options

object[]

Si le type est enumeration, nous devrions avoir une liste d'options parmi lesquelles choisir.

Afficher attributs enfants

tokens.options.label

string

required

Le libellé de l'option qui s'affiche en avant-plan.

tokens.options.value

string

required

La valeur de l'option fournie lors de l'événement.

tokens.updatedAt

string<date-time>

La date et l'heure de la dernière mise à jour du jeton de 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.

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 October 9, 2025

Gets a specific event template for your app

Update an existing event template

⌘I

Extensions d'appel

Extension de visioconférence

Chronologie

Create an event template for your app

Authorizations

Path Parameters

Body

Response