Zum Hauptinhalt springen
POST
/
integrators
/
timeline
/
v3
/
{appId}
/
event-templates
Create an event template
curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates \
  --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

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
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.

Example:

"PetSpot Registration"

​
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.

Example:

"[{\"name\":\"petName\",\"type\":\"string\",\"label\":\"Pet Name\"},{\"name\":\"petAge\",\"type\":\"number\",\"label\":\"Pet Age\"},{\"name\":\"petColor\",\"type\":\"enumeration\",\"label\":\"Pet Color\",\"options\":[{\"label\":\"White\",\"value\":\"white\"},{\"label\":\"Black\",\"value\":\"black\"},{\"label\":\"Brown\",\"value\":\"brown\"},{\"label\":\"Other\",\"value\":\"other\"}]}]"

​
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.

Example:

"contacts"

​
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.

Example:

"Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n **{{question}}**: {{answer}}\n{{/each}}"

​
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.

Example:

"Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})"

Response

successful operation

The current state of the template definition.

​
name
string
required

Le nom du modèle.

​
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.

​
id
string
required

L'ID 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.

​
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.

⌘I