Zum Hauptinhalt springen
POST
/
integrators
/
timeline
/
v3
/
events
Enviar dados do evento (único)
curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/events \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --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
  }
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Starter
Esta API requer um dos seguintes escopos:
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.schemas.companies.write
crm.schemas.contacts.write
crm.schemas.deals.write
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2
timeline

Authorizations

​
private-app
string
header
required

Body

application/json

The timeline event definition.

The state of the timeline event.

​
eventTemplateId
string
required

O ID do modelo do evento.

​
tokens
object
required

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

​
extraData
object

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

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

​
id
string

Identificador do evento. É opcional e recomendamos que você não inclua um. Se você omitir este identificador, criaremos um para você. Você também pode usar "{{uuid}}" em qualquer lugar do ID para gerar uma string única, garantindo a exclusividade.

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

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

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

Response

successful operation

The current state of the timeline event.

​
eventTemplateId
string
required

O ID do modelo do evento.

​
tokens
object
required

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

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

​
objectType
string
required

O ObjectType associado a EventTemplate.

​
createdAt
string<date-time>
​
extraData
object

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

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

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

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