Zum Hauptinhalt springen
POST
/
integrators
/
timeline
/
v3
/
events
Send event data (single)
curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "eventTemplateId": "1001298",
  "email": "art3mis-pup@petspot.com",
  "tokens": {
    "petName": "Art3mis",
    "petAge": 3,
    "petColor": "black"
  },
  "extraData": {
    "questions": [
      {
        "question": "Who'\''s a good girl?",
        "answer": "Bark!"
      },
      {
        "question": "Do you wanna go on a walk?",
        "answer": "Woof!"
      }
    ]
  },
  "timelineIFrame": {
    "linkLabel": "View Art3mis",
    "headerLabel": "Art3mis dog",
    "url": "https://my.petspot.com/pets/Art3mis",
    "width": 600,
    "height": 400
  }
}'
{
  "objectType": "contacts",
  "id": "petspot:1001298:art3mis-pup@petspot.com-004",
  "eventTemplateId": "1001298",
  "email": "art3mis-pup@petspot.com",
  "objectId": "28001",
  "timestamp": "2020-01-30T17:42:10.276Z",
  "tokens": {
    "petName": "Art3mis",
    "petColor": "black",
    "petAge": "3"
  },
  "extraData": {
    "questions": [
      {
        "question": "Who's a good girl?",
        "answer": "Bark!"
      },
      {
        "question": "Do you wanna go on a walk?",
        "answer": "Woof!"
      }
    ]
  },
  "timelineIFrame": {
    "linkLabel": "View Art3mis",
    "headerLabel": "Art3mis dog",
    "url": "https://my.petspot.com/pets/Art3mis",
    "width": 600,
    "height": 400
  }
}
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

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • crm.schemas.contacts.write
  • crm.objects.deals.sensitive.write.v2
  • tickets
  • crm.objects.companies.highly_sensitive.write.v2
  • crm.objects.deals.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.deals.write
  • crm.objects.companies.write
  • tickets.highly_sensitive.v2
  • crm.schemas.deals.write
  • crm.objects.companies.sensitive.write.v2
  • crm.objects.contacts.write
  • crm.schemas.companies.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.contacts.sensitive.write.v2
  • timeline

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The timeline event definition.

The state of the timeline event.

​
eventTemplateId
string
required

L'ID du modèle d'événement.

Example:

"1001298"

​
tokens
object
required

Une collection de clés de jetons et de valeurs associées aux jetons de modèle.

Example:

"{\"petAge\":3,\"petName\":\"Art3mis\",\"petColor\":\"black\"}"

​
extraData
object

Données supplémentaires spécifiques à l'événement pouvant être interprétées par le markdown du modèle.

Example:

"{\"questions\":[{\"answer\":\"Bark!\",\"question\":\"Who's a good girl?\"},{\"answer\":\"Woof!\",\"question\":\"Do you wanna go on a walk?\"}]}"

​
timelineIFrame
object
Example:
{
  "linkLabel": "View Art3mis",
  "headerLabel": "Art3mis dog",
  "url": "https://my.petspot.com/pets/Art3mis",
  "width": 600,
  "height": 400
}
​
domain
string

Le domaine de l'événement (souvent associé à utk).

​
id
string

Identifiant pour l'événement. Ceci est facultatif, et nous vous recommandons de ne pas l'indiquer. Nous en créerons un pour vous si vous l'omettez. Vous pouvez également utiliser {{uuid}} n'importe où dans l'ID pour générer une chaîne unique, garantissant l'unicité.

​
utk
string

Utilisez le paramètre utk pour associer un événement à un contact par usertoken. Ceci est recommandé si vous ne connaissez pas l'e-mail d'un utilisateur, mais que vous avez un jeton utilisateur identifiant dans vos cookies.

​
email
string

L'adresse e-mail utilisée pour des événements spécifiques aux contacts. Cela peut être utilisé pour identifier des contacts existants, en créer de nouveaux ou changer l'e-mail d'un contact existant (si associé à objectId).

Example:

"art3mis-pup@petspot.com"

​
objectId
string

L'identifiant de l'objet CRM. Cela est requis pour chaque événement autre que les contacts (où utk ou e-mail peuvent être utilisés).

​
timestamp
string<date-time>

L'heure à laquelle l'événement s'est produit. Si non spécifiée, l'heure actuelle sera supposée. Cela est utilisé pour déterminer où un événement sera affiché sur la chronologie de l'objet CRM.

Response

successful operation

The current state of the timeline event.

​
eventTemplateId
string
required

L'ID du modèle d'événement.

Example:

"1001298"

​
tokens
object
required

Une collection de clés de jetons et de valeurs associées aux jetons de modèle.

Example:

"{\"petAge\":\"3\",\"petName\":\"Art3mis\",\"petColor\":\"black\"}"

​
id
string
required

Identifiant pour l'événement. Celui-ci doit être unique à l'application et au modèle d'événement. Si vous utilisez le même ID pour différents objets CRM, le dernier à être traité l'emportera et le premier ne bénéficiera pas d'une fiche d'informations. Vous pouvez également utiliser {{uuid}} n'importe où dans l'ID pour générer une chaîne unique, garantissant l'unicité.

Example:

"petspot:1001298:art3mis-pup@petspot.com-004-invalid"

​
objectType
string
required

Le ObjectType associé au EventTemplate.

Example:

"contacts"

​
createdAt
string<date-time>
​
extraData
object

Données supplémentaires spécifiques à l'événement pouvant être interprétées par le markdown du modèle.

Example:

"{\"questions\":[{\"answer\":\"Bark!\",\"question\":\"Who's a good girl?\"},{\"answer\":\"Woof!\",\"question\":\"Do you wanna go on a walk?\"}]}"

​
timelineIFrame
object
Example:
{
  "linkLabel": "View Art3mis",
  "headerLabel": "Art3mis dog",
  "url": "https://my.petspot.com/pets/Art3mis",
  "width": 600,
  "height": 400
}
​
domain
string

Le domaine de l'événement (souvent associé à utk).

​
utk
string

Utilisez le paramètre utk pour associer un événement à un contact par usertoken. Ceci est recommandé si vous ne connaissez pas l'e-mail d'un utilisateur, mais que vous avez un jeton utilisateur identifiant dans vos cookies.

​
email
string

L'adresse e-mail utilisée pour des événements spécifiques aux contacts. Cela peut être utilisé pour identifier des contacts existants, en créer de nouveaux ou changer l'e-mail d'un contact existant (si associé à objectId).

Example:

"art3mis-pup@petspot.com"

​
objectId
string

L'identifiant de l'objet CRM. Cela est requis pour chaque événement autre que les contacts (où utk ou email peuvent être utilisés).

Example:

"28001"

​
timestamp
string<date-time>

L'heure à laquelle l'événement s'est produit. Si non spécifiée, l'heure actuelle sera supposée. Cela est utilisé pour déterminer où un événement sera affiché sur la chronologie de l'objet CRM.

Example:

"2020-01-30T18:37:15.569+00:00"

⌘I