Skip to main content
GET
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
Obtener eventos de marketing por ID externos
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>'
{
  "registrants": 123,
  "eventOrganizer": "<string>",
  "eventUrl": "<string>",
  "attendees": 123,
  "eventType": "<string>",
  "eventCompleted": true,
  "endDateTime": "2023-11-07T05:31:56Z",
  "noShows": 123,
  "cancellations": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "startDateTime": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "sourceId": "",
      "selectedByUser": false,
      "sourceLabel": "",
      "sourceUpstreamDeployable": "<string>",
      "source": "",
      "updatedByUserId": 123,
      "persistenceTimestamp": 123,
      "sourceMetadata": "",
      "dataSensitivity": "",
      "sourceVid": "",
      "unit": "",
      "requestId": "",
      "isEncrypted": false,
      "name": "",
      "useTimestampAsPersistenceTimestamp": true,
      "value": "",
      "selectedByUserTimestamp": 123,
      "timestamp": 123,
      "isLargeValue": true
    }
  ],
  "eventCancelled": true,
  "externalEventId": "<string>",
  "eventDescription": "<string>",
  "eventName": "<string>",
  "id": "<string>",
  "objectId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubStarter

​
Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • crm.objects.marketing_events.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
externalEventId
string
required

El ID del evento de marketing en la aplicación de eventos externos

Query Parameters

​
externalAccountId
string
required

El accountId que está asociado con este evento de marketing en la aplicación de eventos externos.

Response

successful operation

​
registrants
integer
required

El número de contactos de HubSpot que se registraron para este evento de marketing.

​
eventOrganizer
string
required

El nombre del organizador del evento de marketing.

​
attendees
integer
required

El número de contactos de HubSpot que asistieron a este evento de marketing.

​
noShows
integer
required

El número de contactos de HubSpot que se registraron para este evento de marketing, pero no asistieron. Este campo solo tiene un valor cuando el evento ha terminado.

​
cancellations
integer
required

El número de contactos de HubSpot que se registraron para este evento de marketing, pero luego cancelaron su registro.

​
createdAt
string<date-time>
required
​
externalEventId
string
required

El id del evento de marketing en la aplicación de eventos externos.

​
eventName
string
required

El nombre del evento de marketing.

​
id
string
required
​
updatedAt
string<date-time>
required
​
eventUrl
string

Una URL en la aplicación de eventos externos donde se puede gestionar el evento de marketing.

​
eventType
string

El tipo del evento de marketing.

​
eventCompleted
boolean
​
endDateTime
string<date-time>

La fecha y la hora de finalización del evento de marketing.

​
startDateTime
string<date-time>

La fecha y la hora de inicio del evento de marketing.

​
customProperties
object[]

Una lista de PropertyValues. Pueden ser cualquier tipo de nombres y valores de propiedad que desees. Sin embargo, deben existir previamente en la definición del objeto MarketingEvent de la cuenta de HubSpot. Si no es así, serán filtrados y no se establecerán. Para hacer esto, deberás crear un nuevo PropertyGroup en el objeto MarketingEvent de la cuenta de HubSpot para tu aplicación específica y crear la Propiedad Personalizada a la que deseas hacer seguimiento en esa cuenta de HubSpot. No crees ninguna propiedad predeterminada nueva en el objeto MarketingEvent, ya que esa propiedad se aplicará a todas las cuentas de HubSpot.

​
eventCancelled
boolean

Indica si el evento de marketing se canceló.

​
eventDescription
string

La descripción del evento de marketing.

​
objectId
string
⌘I