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": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "type": "date",
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "detailTemplate": "<string>",
  "headerTemplate": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "type": "date",
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "detailTemplate": "<string>",
  "headerTemplate": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Modèles

Create an event template for your app

deprecated

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": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "type": "date",
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "detailTemplate": "<string>",
  "headerTemplate": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "type": "date",
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "detailTemplate": "<string>",
  "headerTemplate": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.

Marketing HubGratuit

Sales HubGratuit

Service HubGratuit

Content HubStarter

Autorisations

hapikey

string

query

requis

Paramètres de chemin

appId

integer<int32>

requis

L'ID de l'application cible.

Corps

application/json

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.

Show child attributes

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

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.

Show child attributes

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

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

Autorisations

Paramètres de chemin

Corps

Réponse