Pular para o conteúdo principal
POST
/
integrators
/
timeline
/
v3
/
events
Enviar dados do evento (único)
curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventTemplateId": "<string>",
  "id": "<string>",
  "tokens": {},
  "customObjectTypeId": "<string>",
  "domain": "<string>",
  "email": "<string>",
  "extraData": {},
  "objectId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "utk": "<string>"
}
'
import requests

url = "https://api.hubapi.com/integrators/timeline/v3/events"

payload = {
"eventTemplateId": "<string>",
"id": "<string>",
"tokens": {},
"customObjectTypeId": "<string>",
"domain": "<string>",
"email": "<string>",
"extraData": {},
"objectId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"utk": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
eventTemplateId: '<string>',
id: '<string>',
tokens: {},
customObjectTypeId: '<string>',
domain: '<string>',
email: '<string>',
extraData: {},
objectId: '<string>',
timestamp: '2023-11-07T05:31:56Z',
utk: '<string>'
})
};

fetch('https://api.hubapi.com/integrators/timeline/v3/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/integrators/timeline/v3/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'eventTemplateId' => '<string>',
'id' => '<string>',
'tokens' => [

],
'customObjectTypeId' => '<string>',
'domain' => '<string>',
'email' => '<string>',
'extraData' => [

],
'objectId' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'utk' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.hubapi.com/integrators/timeline/v3/events"

payload := strings.NewReader("{\n \"eventTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"tokens\": {},\n \"customObjectTypeId\": \"<string>\",\n \"domain\": \"<string>\",\n \"email\": \"<string>\",\n \"extraData\": {},\n \"objectId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"utk\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.hubapi.com/integrators/timeline/v3/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"eventTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"tokens\": {},\n \"customObjectTypeId\": \"<string>\",\n \"domain\": \"<string>\",\n \"email\": \"<string>\",\n \"extraData\": {},\n \"objectId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"utk\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/integrators/timeline/v3/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventTemplateId\": \"<string>\",\n \"id\": \"<string>\",\n \"tokens\": {},\n \"customObjectTypeId\": \"<string>\",\n \"domain\": \"<string>\",\n \"email\": \"<string>\",\n \"extraData\": {},\n \"objectId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"utk\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
eventTemplateId
string
obrigatório

O ID do modelo do evento.

id
string
obrigatório

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.

tokens
object
obrigatório

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

customObjectTypeId
string
domain
string

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

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

extraData
object

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

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

timelineIFrame
object
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.

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.

Resposta

successful operation

eventTemplateId
string
obrigatório

O ID do modelo do evento.

id
string
obrigatório

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
obrigatório

O ObjectType associado a EventTemplate.

tokens
object
obrigatório

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

createdAt
string<date-time>

Não usado.

customObjectTypeId
string
domain
string

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

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

extraData
object

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

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

timelineIFrame
object
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.

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.

Última modificação em 10 de abril de 2026