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
  }
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubKostenlos
Sales HubSales HubKostenlos
Service HubService HubKostenlos
Content HubContent HubStarter

​
Erforderliche Bereiche

Diese API erfordert einen der folgenden Bereiche:
  • 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

Die Event-Vorlagen-ID.

Example:

"1001298"

​
tokens
object
required

Eine Filtergruppe mit Token-Schlüsseln und -Werten, die den Vorlagen-Token zugeordnet sind.

Example:

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

​
extraData
object

Weitere eventspezifische Daten, die vom Markdown der Vorlage interpretiert werden können.

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

Die Event-Domain (häufig gekoppelt mit UTK).

​
id
string

ID für das Event. Optionale Angabe. Es wird empfohlen, keine ID zu übergeben. Wir erstellen eine ID für Sie, sofern hier keine Angabe steht. Mithilfe von „{{uuid}}“ an einer beliebigen Stelle in der ID können Sie eine garantiert eindeutige Zeichenfolge erstellen.

​
utk
string

Verwenden Sie den „utk“-Parameter, um ein Event über das „usertoken“ einem Kontakt zuzuordnen. Dieses Vorgehen wird empfohlen, wenn die E-Mail-Adresse eines Benutzers unbekannt, in Ihrem Cookie jedoch ein identifizierendes Benutzer-Token vorhanden ist.

​
email
string

Die E-Mail-Adresse, die für kontaktspezifische Events verwendet wird. Dies ist hilfreich, um bestehende Kontakte zu identifizieren, neue Kontakte zu erstellen oder die E-Mail-Adresse eines bestehenden Kontakts zu ändern (bei Kopplung mit „objectId“).

Example:

"art3mis-pup@petspot.com"

​
objectId
string

Die CRM-Objekt-ID. Für jedes Event erforderlich, außer bei Kontakten (hier kann UTK oder E-Mail verwendet werden).

​
timestamp
string<date-time>

Die Uhrzeit, zu der das Event aufgetreten ist. Sofern nicht übergeben, wird die aktuelle Uhrzeit herangezogen. Hierüber wird festgelegt, an welcher Stelle ein Event in der Chronik eines CRM-Objekts angezeigt wird.

Response

successful operation

The current state of the timeline event.

​
eventTemplateId
string
required

Die Event-Vorlagen-ID.

Example:

"1001298"

​
tokens
object
required

Eine Filtergruppe mit Token-Schlüsseln und -Werten, die den Vorlagen-Token zugeordnet sind.

Example:

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

​
id
string
required

ID für das Event. Muss für App und Event-Vorlage eindeutig sein. Wenn Sie dieselbe ID für verschiedene CRM-Objekte verwenden, wird die ID für das zuletzt bearbeitete Objekt verwendet und das erste Objekt wird keinem Datensatz zugeordnet. Sie können auch „{{uuid}}“ an beliebiger Stelle in der ID einfügen, um eine eindeutige Zeichenfolge zu generieren.

Example:

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

​
objectType
string
required

ObjectType, der EventTemplate zugeordnet ist.

Example:

"contacts"

​
createdAt
string<date-time>
​
extraData
object

Weitere eventspezifische Daten, die vom Markdown der Vorlage interpretiert werden können.

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

Die Event-Domain (häufig gekoppelt mit UTK).

​
utk
string

Verwenden Sie den „utk“-Parameter, um ein Event über das „usertoken“ einem Kontakt zuzuordnen. Dieses Vorgehen wird empfohlen, wenn die E-Mail-Adresse eines Benutzers unbekannt, in Ihrem Cookie jedoch ein identifizierendes Benutzer-Token vorhanden ist.

​
email
string

Die E-Mail-Adresse, die für kontaktspezifische Events verwendet wird. Dies ist hilfreich, um bestehende Kontakte zu identifizieren, neue Kontakte zu erstellen oder die E-Mail-Adresse eines bestehenden Kontakts zu ändern (bei Kopplung mit „objectId“).

Example:

"art3mis-pup@petspot.com"

​
objectId
string

Die CRM-Objekt-ID. Für jedes Event erforderlich, außer bei Kontakten (hier kann UTK oder E-Mail verwendet werden).

Example:

"28001"

​
timestamp
string<date-time>

Die Uhrzeit, zu der das Event aufgetreten ist. Sofern nicht übergeben, wird die aktuelle Uhrzeit herangezogen. Hierüber wird festgelegt, an welcher Stelle ein Event in der Chronik eines CRM-Objekts angezeigt wird.

Example:

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

⌘I