Passer au contenu principal
GET
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
Obtenir un événement marketing par ID externes
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>'
{
  "attendees": 123,
  "cancellations": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "dataSensitivity": "high",
      "isEncrypted": true,
      "isLargeValue": true,
      "name": "<string>",
      "persistenceTimestamp": 123,
      "requestId": "<string>",
      "selectedByUser": true,
      "selectedByUserTimestamp": 123,
      "source": "ACADEMY",
      "sourceId": "<string>",
      "sourceLabel": "<string>",
      "sourceMetadata": "<string>",
      "sourceUpstreamDeployable": "<string>",
      "sourceVid": [
        123
      ],
      "timestamp": 123,
      "unit": "<string>",
      "updatedByUserId": 123,
      "useTimestampAsPersistenceTimestamp": true,
      "value": "<string>"
    }
  ],
  "eventName": "<string>",
  "eventOrganizer": "<string>",
  "externalEventId": "<string>",
  "id": "<string>",
  "noShows": 123,
  "registrants": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "endDateTime": "2023-11-07T05:31:56Z",
  "eventCancelled": true,
  "eventCompleted": true,
  "eventDescription": "<string>",
  "eventType": "<string>",
  "eventUrl": "<string>",
  "objectId": "<string>",
  "startDateTime": "2023-11-07T05:31:56Z"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

externalEventId
string
requis

L'identifiant de l'événement marketing dans l'application d'événements externe

Paramètres de requête

externalAccountId
string
requis

L'ID de compte associé à cet événement marketing dans l'application d'événement externe.

Réponse

successful operation

attendees
integer<int32>
requis

Le nombre de contacts HubSpot qui ont assisté à cet événement marketing.

cancellations
integer<int32>
requis

Le nombre de contacts HubSpot qui se sont inscrits à cet événement marketing, mais ont annulé leur inscription par la suite.

createdAt
string<date-time>
requis

La date et l'heure de création de l'événement marketing.

customProperties
object[]
requis

Une liste de « PropertyValues ». Il peut s'agir de n'importe quel type de noms et de valeurs de propriétés que vous souhaitez. Toutefois, ils doivent déjà exister dans la définition de l'objet « MarketingEvent » du compte HubSpot. S'ils n'existent pas, ils seront filtrés et non définis. Pour ce faire, vous devrez créer un nouveau «  PropertyGroup » sur l'objet MarketingEvent du compte HubSpot pour votre application spécifique et créer la propriété personnalisée que vous souhaitez suivre sur ce compte HubSpot. Ne créez aucune nouvelle propriété par défaut sur l'objet MarketingEvent, car cela s'appliquerait à tous les comptes HubSpot.

eventName
string
requis

Le nom de l'événement marketing.

eventOrganizer
string
requis

Le nom de l'organisateur de l'événement marketing.

externalEventId
string
requis

L'identifiant de l'événement marketing dans l'application d'événements externe.

id
string
requis

L'ID de l'objet CRM de l'événement marketing.

noShows
integer<int32>
requis

Le nombre de contacts HubSpot qui se sont inscrits à cet événement marketing, mais n'y ont pas assisté. Ce champ n'a de valeur que lorsque l'événement est terminé.

registrants
integer<int32>
requis

Le nombre de contacts HubSpot qui se sont inscrits à cet événement marketing.

updatedAt
string<date-time>
requis

La date et l'heure de mise à jour de l'événement marketing.

endDateTime
string<date-time>

La date et l'heure de fin de l'événement marketing.

eventCancelled
boolean

Indique si l'événement marketing a été annulé.

eventCompleted
boolean

Indique si l'événement marketing est terminé.

eventDescription
string

La description de l'événement marketing.

eventType
string

Le type de l'événement marketing.

eventUrl
string

Une URL dans l'application d'événement externe d'où il est possible de gérer l'événement marketing.

objectId
string

L'ID de l'objet CRM de l'événement marketing.

startDateTime
string<date-time>

La date et l'heure de début de l'événement marketing.

Last modified on December 9, 2025