Pular para o conteúdo principal
GET
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
Obter evento de marketing por IDs externos
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"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

externalEventId
string
obrigatório

Parâmetros de consulta

externalAccountId
string
obrigatório

Resposta

successful operation

attendees
integer<int32>
obrigatório

O número de contatos do HubSpot que participaram deste evento de marketing.

cancellations
integer<int32>
obrigatório

O número de contatos do HubSpot que se inscreveram neste evento de marketing, mas depois cancelaram a inscrição.

createdAt
string<date-time>
obrigatório

A data e hora de criação do evento de marketing.

customProperties
object[]
obrigatório

Uma lista de PropertyValues. Estes podem ser qualquer tipo de nomes e valores de propriedade que você quiser. No entanto, já devem existir na definição do objeto MarketingEvent na conta da HubSpot. Se não existirem, eles serão filtrados e não definidos. Para fazer isso, você precisará criar um novo PropertyGroup no objeto MarketingEvent na conta da HubSpot para seu aplicativo específico e criar a Propriedade personalizada que deseja rastrear nessa conta da HubSpot. Não crie novas propriedades padrão no objeto MarketingEvent, pois estas serão aplicadas a todas as contas da HubSpot.

eventName
string
obrigatório

O nome do evento de marketing.

eventOrganizer
string
obrigatório

O nome do organizador do evento de marketing.

externalEventId
string
obrigatório

O ID do evento de marketing no aplicativo de eventos externos.

id
string
obrigatório

O ID do objeto do CRM do evento de marketing.

noShows
integer<int32>
obrigatório

O número de contatos do HubSpot que se inscreveram neste evento de marketing, mas não compareceram. Esse campo só tem um valor quando o evento termina.

registrants
integer<int32>
obrigatório

O número de contatos do HubSpot que se inscreveram neste evento de marketing.

updatedAt
string<date-time>
obrigatório

A data e hora da atualização do evento de marketing.

endDateTime
string<date-time>

A data e hora de término do evento de marketing.

eventCancelled
boolean

Indica se o evento de marketing foi cancelado.

eventCompleted
boolean

Indica se o evento de marketing foi concluído.

eventDescription
string

A descrição do evento de marketing.

eventType
string

O tipo do evento de marketing.

eventUrl
string

Um URL no aplicativo de eventos externos onde o evento de marketing pode ser gerenciado.

objectId
string

O ID do objeto do CRM do evento de marketing.

startDateTime
string<date-time>

A data e hora de início do evento de marketing.

Last modified on March 24, 2026