Zum Hauptinhalt springen
GET
/
integrators
/
timeline
/
v3
/
events
/
{eventTemplateId}
/
{eventId}
Obter uma instância de evento
curl --request GET \
  --url https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId} \
  --header 'Authorization: Bearer <token>'
{
  "objectType": "contacts",
  "id": "petspot:1001298:art3mis-pup@petspot.com-004-invalid",
  "eventTemplateId": "1001298",
  "email": "art3mis-pup@petspot.com",
  "objectId": "28001",
  "timestamp": "2020-01-30T18:37:15.569Z",
  "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
  }
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • crm.objects.contacts.read
  • crm.objects.deals.read
  • tickets
  • crm.objects.companies.sensitive.read.v2
  • tickets.sensitive.v2
  • crm.objects.companies.read
  • crm.objects.contacts.highly_sensitive.read.v2
  • crm.schemas.deals.read
  • crm.schemas.contacts.read
  • tickets.highly_sensitive.v2
  • crm.objects.deals.sensitive.read.v2
  • crm.objects.deals.highly_sensitive.read.v2
  • crm.objects.companies.highly_sensitive.read.v2
  • crm.objects.contacts.sensitive.read.v2
  • timeline
  • crm.schemas.companies.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
eventTemplateId
string
required

O ID do modelo do evento.

​
eventId
string
required

O ID do evento.

Response

successful operation

The current state of the timeline event.

​
eventTemplateId
string
required

O ID do modelo do evento.

Example:

"1001298"

​
tokens
object
required

Uma coleção de chaves de token e valores associados aos tokens do modelo.

Example:

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

​
id
string
required

Identificador do evento. Deve ser exclusivo para o aplicativo e modelo de evento. Se você usar o mesmo ID para diferentes objetos do CRM, o último a ser processado prevalecerá e o primeiro não terá um registro. Você também pode usar "{{uuid}}" em qualquer lugar no ID para gerar uma string única, garantindo a exclusividade.

Example:

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

​
objectType
string
required

O ObjectType associado a EventTemplate.

Example:

"contacts"

​
createdAt
string<date-time>
​
extraData
object

Dados adicionais específicos do evento que podem ser interpretados pelo markdown do modelo.

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

O domínio do evento (frequentemente pareado com o utk).

​
utk
string

Use o parâmetro "utk" para associar um evento com um contato pelo "usertoken". É recomendado fazer isso se você não souber o e-mail de um usuário, mas tiver um token de identificação do usuário em seus cookies.

​
email
string

O endereço de e-mail usado para eventos específicos de contato. Pode ser usado para identificar contatos existentes, criar novos contatos ou alterar o e-mail de um contato existente (se estiver pareado com o "objectId").

Example:

"art3mis-pup@petspot.com"

​
objectId
string

O identificador do objeto do CRM. É necessário para todos os eventos, exceto contatos (nos quais o utk ou o e-mail podem ser usados).

Example:

"28001"

​
timestamp
string<date-time>

A hora em que o evento ocorreu. Se não for transmitido, a hora atual será usada. É usado para determinar onde um evento é mostrado na linha do tempo de um objeto do CRM.

Example:

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

⌘I