Get an event instance

Rufen Sie eine Event-Instanz unter Angabe der Vorlagen-ID und der Event-ID ab.

GET /integrators/timeline/v3/events/{eventTemplateId}/{eventId}

Eine Event-Instanz abrufen

cURL

curl --request GET \
  --url https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId} \
  --header 'Authorization: Bearer <token>'

200

{
  "eventTemplateId": "<string>",
  "id": "<string>",
  "objectType": "<string>",
  "tokens": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "customObjectTypeId": "<string>",
  "domain": "<string>",
  "email": "<string>",
  "extraData": {},
  "objectId": "<string>",
  "timelineIFrame": {
    "headerLabel": "<string>",
    "height": 123,
    "linkLabel": "<string>",
    "url": "<string>",
    "width": 123
  },
  "timestamp": "2023-11-07T05:31:56Z",
  "utk": "<string>"
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

eventId · string · erforderlich

Die Event-ID.

eventTemplateId · string · erforderlich

Die Event-Vorlagen-ID.

Antwort

200

application/json

successful operation

eventTemplateId · string · erforderlich

Die Event-Vorlagen-ID.

id · string · erforderlich

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.

objectType · string · erforderlich

ObjectType, der EventTemplate zugeordnet ist.

tokens · object · erforderlich

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

Show child attributes

createdAt · string<date-time>

Nicht verwendet.

customObjectTypeId · string

domain · string

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

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“).

extraData · object

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

objectId · string

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

timelineIFrame · object

Show child attributes

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.

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.