Créer un modèle d'événement

curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "detailTemplate": "<string>",
  "headerTemplate": "<string>"
}
'

import requests

url = "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"

payload = {
    "name": "<string>",
    "objectType": "<string>",
    "tokens": [
        {
            "label": "<string>",
            "name": "<string>",
            "options": [
                {
                    "label": "<string>",
                    "value": "<string>"
                }
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "objectPropertyName": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z"
        }
    ],
    "detailTemplate": "<string>",
    "headerTemplate": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    objectType: '<string>',
    tokens: [
      {
        label: '<string>',
        name: '<string>',
        options: [{label: '<string>', value: '<string>'}],
        createdAt: '2023-11-07T05:31:56Z',
        objectPropertyName: '<string>',
        updatedAt: '2023-11-07T05:31:56Z'
      }
    ],
    detailTemplate: '<string>',
    headerTemplate: '<string>'
  })
};

fetch('https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'objectType' => '<string>',
    'tokens' => [
        [
                'label' => '<string>',
                'name' => '<string>',
                'options' => [
                                [
                                                                'label' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'createdAt' => '2023-11-07T05:31:56Z',
                'objectPropertyName' => '<string>',
                'updatedAt' => '2023-11-07T05:31:56Z'
        ]
    ],
    'detailTemplate' => '<string>',
    'headerTemplate' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"objectType\": \"<string>\",\n  \"tokens\": [\n    {\n      \"label\": \"<string>\",\n      \"name\": \"<string>\",\n      \"options\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"objectPropertyName\": \"<string>\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"detailTemplate\": \"<string>\",\n  \"headerTemplate\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"objectType\": \"<string>\",\n  \"tokens\": [\n    {\n      \"label\": \"<string>\",\n      \"name\": \"<string>\",\n      \"options\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"objectPropertyName\": \"<string>\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"detailTemplate\": \"<string>\",\n  \"headerTemplate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"objectType\": \"<string>\",\n  \"tokens\": [\n    {\n      \"label\": \"<string>\",\n      \"name\": \"<string>\",\n      \"options\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"objectPropertyName\": \"<string>\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"detailTemplate\": \"<string>\",\n  \"headerTemplate\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "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"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

v3 event types external

Create an event template

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 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "detailTemplate": "<string>",
  "headerTemplate": "<string>"
}
'

import requests

url = "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"

payload = {
    "name": "<string>",
    "objectType": "<string>",
    "tokens": [
        {
            "label": "<string>",
            "name": "<string>",
            "options": [
                {
                    "label": "<string>",
                    "value": "<string>"
                }
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "objectPropertyName": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z"
        }
    ],
    "detailTemplate": "<string>",
    "headerTemplate": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    objectType: '<string>',
    tokens: [
      {
        label: '<string>',
        name: '<string>',
        options: [{label: '<string>', value: '<string>'}],
        createdAt: '2023-11-07T05:31:56Z',
        objectPropertyName: '<string>',
        updatedAt: '2023-11-07T05:31:56Z'
      }
    ],
    detailTemplate: '<string>',
    headerTemplate: '<string>'
  })
};

fetch('https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'objectType' => '<string>',
    'tokens' => [
        [
                'label' => '<string>',
                'name' => '<string>',
                'options' => [
                                [
                                                                'label' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'createdAt' => '2023-11-07T05:31:56Z',
                'objectPropertyName' => '<string>',
                'updatedAt' => '2023-11-07T05:31:56Z'
        ]
    ],
    'detailTemplate' => '<string>',
    'headerTemplate' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"objectType\": \"<string>\",\n  \"tokens\": [\n    {\n      \"label\": \"<string>\",\n      \"name\": \"<string>\",\n      \"options\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"objectPropertyName\": \"<string>\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"detailTemplate\": \"<string>\",\n  \"headerTemplate\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"objectType\": \"<string>\",\n  \"tokens\": [\n    {\n      \"label\": \"<string>\",\n      \"name\": \"<string>\",\n      \"options\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"objectPropertyName\": \"<string>\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"detailTemplate\": \"<string>\",\n  \"headerTemplate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"objectType\": \"<string>\",\n  \"tokens\": [\n    {\n      \"label\": \"<string>\",\n      \"name\": \"<string>\",\n      \"options\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"objectPropertyName\": \"<string>\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"detailTemplate\": \"<string>\",\n  \"headerTemplate\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "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"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Autorisations

Authorization

string

header

requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

appId

integer<int32>

requis

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.

Dernière modification le 31 mars 2026

Add tokens to an existing template

Get an event template

⌘I

Account & Settings

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Événements

Fichiers

Marketing

Reporting

Planificateur

Webhooks

Create an event template

Autorisations

Paramètres de chemin

Corps

Réponse