Zum Hauptinhalt springen
POST
/
events
/
v3
/
send
Enviar uma conclusão de evento personalizado
curl --request POST \
  --url https://api.hubapi.com/events/v3/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "occurredAt": "2023-11-07T05:31:56Z",
  "eventName": "pe123456_account_login",
  "utk": "<string>",
  "uuid": "<string>",
  "email": "mark.s@lumon.industries",
  "properties": "{\"hs_page_id\":\"1234567890\",\"hs_element_id\":\"login-button\",\"hs_page_title\":\"homepage\"}",
  "objectId": "089274502"
}'
This response has no body data.
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • analytics.behavioral_events.send

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
eventName
string
required

O nome interno do evento ("pe<portalID>_eventName"). Pode ser recuperado por meio da API de definições de eventos ou na UI do HubSpot.

Example:

"pe123456_account_login"

​
occurredAt
string<date-time>

A hora em que este evento ocorreu. Se não estiver definido, a hora atual será utilizada.

​
utk
string

O usertoken do visitante. Usado para associar os dados do evento a um registro do CRM.

​
uuid
string

Inclua um identificador universalmente exclusivo para atribuir um ID exclusivo à conclusão do evento. Pode ser útil para combinar dados entre o HubSpot e outros sistemas externos.

​
email
string

O endereço de e-mail do visitante. Usado para associar os dados do evento a um registro do CRM.

Example:

"mark.s@lumon.industries"

​
properties
object

As propriedades do evento a serem atualizadas. Assume o formato de pares de chave-valor (nome interno da propriedade e valor da propriedade). Saiba mais sobre propriedades de evento padrão do HubSpot.

Example:

"{\"hs_page_id\":\"1234567890\",\"hs_element_id\":\"login-button\",\"hs_page_title\":\"homepage\"}"

​
objectId
string

O ID do objeto que concluiu o evento (por exemplo, ID de contato ou ID de visitante).

Example:

"089274502"

⌘I