POST
/
events
/
v3
/
send
Envoyer une complétion d'événement personnalisée
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.
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubEntreprise
Sales HubSales HubEntreprise
Service HubService HubEntreprise
Content HubContent HubEntreprise

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • 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

Le nom interne de l'événement ('pe<portalID>_eventName'). Peut être récupéré via [l'API de définition des événements] (https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#get-%2Fevents%2Fv3%2Fevent-definitions) ou dans [l'interface utilisateur de HubSpot] (https://knowledge.hubspot.com/reports/create-custom-behavioral-events-with-the-code-wizard#find-internal-name).

Example:

"pe123456_account_login"

​
occurredAt
string<date-time>

Le moment où cet événement s'est produit. S'il n'est pas défini, l'heure actuelle sera utilisée.

​
utk
string

Le 'usertoken' du visiteur. Utilisé pour associer les données de l'événement à une fiche d'informations CRM.

​
uuid
string

Ajoutez un GUID pour attribuer un identifiant unique à la fin de l'événement. Peut être utile pour faire correspondre les données entre HubSpot et d'autres systèmes externes.

​
email
string

L'adresse e-mail du visiteur. Utilisée pour associer les données de l'événement à une fiche d'informations CRM.

Example:

"mark.s@lumon.industries"

​
properties
object

Les propriétés de l'événement à mettre à jour. Suit le format des paires clé-valeur (nom interne de la propriété et valeur de la propriété). En savoir plus sur [les propriétés d'événement par défaut de HubSpot] (https://developers.hubspot.com/docs/guides/api/analytics-and-events/custom-events/custom-event-definitions#hubspot-s-default-event-properties).

Example:

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

​
objectId
string

L'ID de l'objet qui a terminé l'événement (par exemple, l'ID du contact ou l'ID du visiteur).

Example:

"089274502"