Última modificação: 8 de outubro de 2025
Um evento de marketing é um Objeto do CRM, semelhante a contatos e empresas, que permite rastrear eventos de marketing, como uma webinar, juntamente com os contatos que se registraram e participaram do evento. Abaixo, saiba mais sobre como trabalhar com a API de eventos de marketing para integrar eventos de marketing a um app.
Neste artigo
Requisitos do escopo
Para fazer uma solicitação de API para um dos pontos de extremidade de evento de marketing, são necessários os seguintes escopos:
crm.objects.marketing_events.read
: concede permissão para recuperar dados de eventos de marketing e de presença.
crm.objects.marketing_events.write
: concede permissão para criar, excluir ou fazer alterações nas informações do evento de marketing.
Ao autenticar chamadas feitas pelo seu app, você pode usar um token de acesso de app privado ou OAuth. Saiba mais sobre métodos de autenticação. Para a lista completa de endpoints disponíveis, confira a documentação de referência.
Diferenças entre pontos de extremidade de ID interno e externo
Muitos endpoints abaixo fornecem duas maneiras diferentes de identificar um evento que você deseja buscar ou atualizar. Embora o resultado final para endpoints semelhantes possa ser o mesmo, eles diferem principalmente nos IDs associados que você fornece:
- Pontos de extremidade usando IDs externos: pontos finais que requerem
externalEventId
e externalAccountId
Os parâmetros só funcionarão no mesmo aplicativo que criou originalmente o evento. Por exemplo, se você criou dois aplicativos públicos, chamados Apl. A e Apl. B, e você criou um evento de marketing por meio da autenticação e das IDs associadas ao Apl. A, apenas Apl. A O pode ler, atualizar ou adicionar novos participantes ao evento. Se você tentar acessar o mesmo evento com Apl. B usando o mesmo externalEventId e externalAccountId, ocorrerá um erro 404.
- Endpoints usando um objectId: endpoints que requerem um
objectId
podem ser usados para acessar um evento por qualquer aplicativo com os escopos associados listados na seção acima, independentemente do aplicativo que criou originalmente o evento. Se Apl. A criou um evento de marketing, Apl. B ainda é possível ler, atualizar ou adicionar participantes por meio de objectId
pontos de extremidade baseados em .
Pontos de extremidade de gerenciamento de eventos
As seções a seguir fornecem contexto sobre propriedades comuns de eventos e detalham como usar os vários pontos de extremidade de gerenciamento de eventos para criar, ler, atualizar e arquivar eventos.
Propriedades do evento
As seguintes propriedades estão disponíveis para busca e atualização ao usar os endpoints de gerenciamento de eventos:
Parâmetro | Tipo | Descrição |
---|
eventName | String | O título do seu evento. |
eventType | String | O tipo do evento (por exemplo, webinar, feira comercial, etc.). |
eventOrganizer | String | O indivíduo ou organização que está organizando o evento. |
eventDescription | String | Uma descrição para seu evento. |
eventUrl | String | Uma URL para que os usuários possam navegar e obter mais detalhes e/ou se registrar para seu evento. |
eventCancelled | Booleano | Se o evento foi cancelado ou não. |
eventStartTime | String | Um registro de data e hora no formato ISO 8601 do horário de início do evento. |
eventEndTime | Sequência de caracteres | Um timestamp formatado ISO 8601 da hora de término do evento. |
Criar um evento
Para criar um evento de marketing, você pode fazer um pedido POST
para /marketing/v3/marketing-events/events
e fornecer o eventName
, externalEventId
, externalAccountId
, e eventOrganizer
no corpo da sua solicitação. Você pode opcionalmente fornecer quaisquer propriedades adicionais listadas na tabela acima no seu pedido.
Por exemplo, se o externalAccountId
do seu aplicativo é "12345"
, e o externalEventId
do seu evento no seu aplicativo é "67890"
, você pode criar um novo evento chamado "Winter webinar"
com uma solicitação que seria semelhante à seguinte:
{
"externalAccountId": "12345",
"externalEventId": "67890",
"eventName": "Winter webinar",
"eventOrganizer": "Snowman Fellowship",
"eventCancelled": false,
"eventUrl": "https://example.com/holiday-jam",
"eventDescription": "Let's get together to plan for the holidays",
"eventCompleted": false,
"startDateTime": "2024-08-07T12:36:59.286Z",
"endDateTime": "2024-08-07T12:36:59.286Z",
"customProperties": [
{
"name": "eventSeason",
"value": "winter"
}
]
}
Atualizar propriedades de eventos usando IDs externos
Você pode atualizar eventos de marketing fazendo um pedido POST
para endpoint /marketing/v3/marketing-events/events/upsert
. Você pode incluir qualquer customProperties
juntamente com quaisquer outros detalhes do seu evento (incluindo nome, hora de início e descrição).
Se já existir um evento de marketing com o ID especificado na solicitação, este será atualizado. Caso contrário, um novo evento será criado.
Por exemplo, a seguinte solicitação criaria um evento com um ID 4
chamado “Virtual cooking class”:
{
"inputs": [
{
"customProperties": [
{
"name": "property1",
"value": "1234"
}
],
"eventName": "Virtual cooking class",
"startDateTime": "2023-11-30T17:46:20.461Z",
"eventOrganizer": "Chef Joe",
"eventDescription": "Join us for a virtual cooking class! Yum."
"eventCancelled": false,
"externalAccountId": "CookingCo",
"externalEventId": "4"
}
]
}
Atualizar propriedades do evento usando seu objectId
Depois que um evento é criado, você pode atualizar suas propriedades fazendo um pedido PATCH
para /marketing/v3/marketing-events/{objectId}
.
- Para obter o
objectId
para um evento de marketing específico, siga as instruções deste artigo da base de conhecimento para visualizar os detalhes de um evento em sua conta HubSpot, localize o ID em ID do registro. O objectId
também será retornado na resposta quando você criar um evento com sucesso.
- Você também pode fazer uma
GET
solicitação para o /marketing/v3/marketing-events
ponto final descrito na próxima seção.
- Se você tem o
externalEventId
de um evento, você pode incluí-lo como um caminho ao fazer um pedido GET
para /marketing/v3/marketing-events/{externalEventId}/identifiers
. A resposta incluirá todos os eventos de marketing juntamente com os identificadores relevantes para cada evento (ou seja, o evento objectId
, isso é appInfo
, o marketingEventName
, e o externalAccountId
).
Obter detalhes do evento
Para obter uma lista de todos os eventos de marketing junto com suas propriedades, faça um pedido GET
para /marketing/v3/marketing-events
.
Se você precisar recuperar os detalhes de um evento de marketing específico pelo ID do registro no HubSpot, você pode fornecer a ID como a objectId num GET
solicitar /marketing/v3/marketing-events/{objectId}
.
{
"eventName": "Test Marketing Event",
"eventType": "test-type",
"startDateTime": "2024-05-22T12:29:50.734Z",
"endDateTime": "2024-05-25T12:29:50.734Z",
"eventOrganizer": "testEventOrganizer",
"eventDescription": "testDescription",
"eventUrl": "testURL",
"eventCancelled": true,
"eventCompleted": false,
"customProperties": [
{
"name": "test_custom_prop",
"value": "1"
},
{
"name": "test_prop",
"value": "2"
}
],
"objectId": "58237132332",
"externalEventId": null,
"eventStatus": "CANCELLED",
"appInfo": {
"id": "111",
"name": "Zoom"
},
"registrants": 1,
"attendees": 1,
"cancellations": 2,
"noShows": 0,
"createdAt": "2024-08-07T12:58:40.635Z",
"updatedAt": "2024-10-15T13:35:03.353Z"
}
Excluir um evento
Para excluir um evento de marketing, faça um pedido DELETE
para /marketing/v3/marketing-events/{objectId}
com o evento associado objectId
.
Se for bem-sucedido, você receberá uma resposta 204 No Content
.
Atualizar vários eventos em massa
Para atualizar vários eventos de marketing em massa, você pode fazer um pedido POST
para /marketing-events/v3/marketing-events/batch/update
. Forneça as propriedades que você deseja atualizar para cada evento dentro da matriz de entradas do corpo da solicitação.
Por exemplo, se você quisesse atualizar várias propriedades de dois eventos de marketing com IDs de objeto de 58237132332 e 54073507364 em uma única solicitação, o corpo da sua solicitação seria semelhante ao seguinte:
{
"inputs": [
{
"objectId": "58237132332",
"eventCancelled": true,
"eventOrganizer": "testEventOrganizer",
"eventUrl": "testURL",
"eventDescription": "testDescription",
"eventName": "Test Marketing Event Update",
"eventType": "test-type"
},
{
"objectId": "54073507364",
"eventCancelled": true,
"eventOrganizer": "testEventOrganizer",
"eventUrl": "testURL",
"eventDescription": "testDescription",
"eventName": "Test Marketing Event Update 2",
"eventType": "test-type"
}
]
}
Pontos de extremidade de participação em eventos
Os pontos de extremidade de estado de presença no evento permitem que você registre atividades de registro para um contato, como se ele se registrou, compareceu ou cancelou o registro para o seu evento. Por exemplo, você pode usar esse ponto de extremidade para registrar que um contato HubSpot se inscreveu em um evento de marketing.
Atualizar presença usando o evento objectId
Se você quiser usar o objectId
de um evento de marketing, você pode usar o ID de contato do contato cujo estado de participação você deseja registrar ou pode usar o endereço de e-mail dele.
- Para usar o ID de um contato, faça uma solicitação POST para
/marketing/v3/marketing-events/{objectId}/attendance/{subscribeState}/create
então forneça o ID do contato usando o vid
campo dentro do inputs
matriz do corpo da sua solicitação. Por exemplo, o corpo da solicitação abaixo fornece um exemplo de atualização dos dados de atendimento para um contato com uma ID de 47733471576
e especificando quando o participante entrou e saiu do evento por meio do joinedAt
e leftAt
Propriedades:
{
"inputs": [
{
"vid": 47733471576,
"properties": {
"joinedAt": "2024-05-22T13:38:16.500Z",
"leftAt": "2024-05-22T15:40:16.500Z"
},
"interactionDateTime": 1716382579000
}
]
}
- Para usar o e-mail de um contato, faça uma solicitação POST para
/marketing/v3/marketing-events/{objectId}/attendance/{subscribeState}/email-create
então forneça o e-mail do contato usando o campo email
dentro da matriz inputs
do corpo da sua solicitação.
- Se você estiver criando um novo contato, poderá incluir o campo
contactProperties
dentro da matriz inputs
do corpo da sua solicitação para definir quaisquer propriedades associadas no contato recém-criado. Caso contrário, se o contato já existir, o contactProperties
fornecido na solicitação não será atualizado.
- Por exemplo, o corpo da solicitação abaixo fornece um exemplo de atualização dos dados de atendimento para um contato com um endereço de e-mail de
john@example.com
e especificando quando o participante entrou e saiu do evento por meio dos campos joinedAt
e leftAt
dentro do objeto properties
da sua matriz inputs
:
{
"inputs": [
{
"contactProperties": {
"additionalProp1": "string",
"additionalProp2": "string"
},
"properties": {
"joinedAt": "2024-05-22T13:38:16.500Z",
"leftAt": "2024-05-22T15:40:16.500Z"
},
"email": "john@example.com",
"interactionDateTime": 1716382579000
}
]
}
Para qualquer uma das abordagens acima, forneça os seguintes valores para os parâmetros de caminho correspondentes:
objectId
: o ID do registro do evento de marketing na sua conta HubSpot. Confira a seção acima para obter mais detalhes sobre o uso de objectId de um evento versus usar seus IDs externos.
subscriberState
: uma enumeração que corresponde ao novo status de participação do contato:
REGISTERED
: indica que o contato da HubSpot se inscreveu para o evento.
ATTENDED
: indica que o contato da HubSpot participou do evento. Se estiver atualizando o status de um contato para COMPARECEU, você também pode incluir as datas/horas joinedAt
e leftAt
como parâmetros no corpo da solicitação, especificados no formato ISO8601 Instant.
CANCELLED
: indica que o contato da HubSpot, que já havia se inscrito para o evento, cancelou sua inscrição.
Atualizar a presença usando os IDs externos do evento
Observação:
Se você estava usando anteriormente os endpoints /upsert
ou /email-upsert
para atualizar o status de um participante, você pode usar os endpoints alternativos listados abaixo. No entanto, em comparação com os endpoints de participação em eventos acima, o uso desses pontos finais não fornecerá suporte para o seguinte:
- Criando um novo contato caso ele ainda não exista.
- Exibindo eventos da linha do tempo na página de registro de contato.
- Especificando as propriedades
joinedAt
ou leftAt
.
- Fornecendo uma resposta detalhada em caso de sucesso.
Se você usar os endpoints que exigem o externalEventId
no seu aplicativo, você pode usar os IDs de contato ou endereços de e-mail de contatos existentes:
- Se você quiser usar os IDs de contato de contatos existentes:
- Faça uma solicitação
POST
para /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create
, usando o ID do evento de seu aplicativo externo como externalEventId
.
- No corpo da solicitação, forneça um objeto
inputs
que inclua os seguintes campos:
interactionDateTime
: a data e hora em que o contato se inscreveu no evento.
vid
: o ID de contato de um contato existente.
- Caso queira usar o endereço de e-mail de um dos participantes do evento:
- Faça uma solicitação
POST
para /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create
.
- No corpo da solicitação, forneça um objeto
inputs
que inclua os seguintes campos:
interactionDateTime
: a data e hora em que o contato se inscreveu no evento.
email
: o endereço de e-mail do participante como o valor do campo de e-mail em uma entrada
- Se o endereço de e-mail que você incluir não corresponder ao endereço de um contato existente, um novo contato será criado.
Para ambos os pontos de extremidade acima, forneça os seguintes valores para os parâmetros de caminho correspondentes:
externalEventId
: o ID do evento de marketing. Confira a seção acima para obter mais detalhes sobre o uso de objectId de um evento versus usar seus IDs externos.
subscriberState
: uma enumeração que corresponde ao novo status de participação do contato:
REGISTERED
: indica que o contato da HubSpot se inscreveu para o evento.
ATTENDED
: indica que o contato da HubSpot participou do evento. Se estiver atualizando o status de um contato para COMPARECEU, você também pode incluir as datas/horas joinedAt
e leftAt
como parâmetros no corpo da solicitação, especificados no formato ISO8601 Instant.
CANCELLED
: indica que o contato da HubSpot, que já havia se inscrito para o evento, cancelou sua inscrição.
Observação:
Essas APIs são idempotentes, desde que o ID do contato e o valor de interactionDateTime
no evento não tenham mudado. Isso permite que você defina com segurança o estado do presença várias vezes sem que o HubSpot crie eventos duplicados nas propriedades de eventos de marketing.
Pontos de extremidade de estado do participante
Você pode usar os pontos de extremidade de participação para recuperar dados de participantes para seus eventos de marketing. Você pode consultar dados, como métricas agregadas para um evento específico, bem como dados de participantes para um contato ou evento específico.
Analise os pontos de extremidade de participação disponíveis abaixo. Para uma referência completa de todos os parâmetros disponíveis para cada ponto final, consulte a documentação de referência.
Observação:
As contagens de atividade na página de eventos de marketing em sua conta da HubSpot podem diferir das métricas agregadas correspondentes do ponto de extremidade de API dos contadores de participação.Por exemplo, se um participante se inscreveu para um evento, cancelou e se inscreveu novamente para o mesmo evento, cada uma dessas atividades será incluída nos totais que você vê na UI de eventos de marketing em sua conta. Se você estiver usando os pontos de extremidade de estado do participante abaixo, somente o estado atual de um participante será incluído no contador associado para essa métrica (por exemplo, attended
, registered
, cancelled
ou noShows
).
Ler participações de um contato específico
Para obter dados de participação em eventos para um contato específico, faça uma solicitação GET
para /marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown
, usando o ID ou o endereço de e-mail do contato como parâmetro de caminho contactIdentifier
.
A resposta incluirá um resumo da participação no evento do contato no campo properties
:
{
"results": [
{
"associations": {
"marketingEvent": {
"externalAccountId": "4",
"marketingEventId": "123",
"externalEventId": "456",
"name": "Virtual baking workshop"
},
"contact": {
"firstname": "Jane",
"contactId": "156792341",
"email": "jdoe@example.com",
"lastname": "Doe"
}
},
"createdAt": "2024-05-21T18:35:04.838Z",
"id": "string",
"properties": {
"occurredAt": "2024-05-22T10:35:04.838Z",
"attendancePercentage": "string",
"attendanceState": "REGISTERED",
"attendanceDurationSeconds": 3600
}
}
]
}
Ler dados de detalhamento de participação
Para obter um detalhamento dos dados de participação para um evento específico, use externalAccountId
e externalEventId
do seu evento para fazer uma solicitação GET
para /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown
.
Ler contadores de participação
Para obter um resumo agregado da participação em um evento, use externalAccountId
e externalEventId
do seu evento para fazer uma solicitação GET
para /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}
.
A resposta incluirá as contagens totais de participação:
{
"attended": 152,
"registered": 200,
"cancelled": 3,
"noShows": 8
}
Filtrar dados de detalhamento de participação
Ao buscar dados detalhados ou dados de participação em eventos para um contato específico, você pode filtrar os dados resultantes usando os campos contactIdentifier, estado, limite ou após como parâmetros de consulta em sua solicitação.
Parâmetro de consulta | Tipo | Descrição |
---|
contactIdentifier | string | O ID ou o endereço de e-mail de um contato específico |
state | Enumeração | O estado de participação do evento. Os possíveis estados de participação são:REGISTERED : o contato se registrou para o eventoCANCELLED : o registro do contato foi cancelado.ATTENDED : o contato participou do evento.NO_SHOW : o contato se registrou, mas acabou não participando do evento.
|
limit | Número | Limitar os resultados retornados. Por padrão, o limite é definido como 10. O intervalo válido é de 1 a 100. |
after | Número | Usado para paginação entre resultados na resposta. Consulte a diferença especificada na página anterior dos dados de resposta para determinar o próximo índice de resultados a ser retornado. |
Listar pontos de extremidade de associação
Você pode usar os endpoints descritos nas seções abaixo para gerenciar associações entre listas e seus eventos de marketing.
Muitos desses pontos finais exigem um listId
como um parâmetro de caminho, que você pode encontrar na página de detalhes da lista na sua conta HubSpot:
- Na sua conta HubSpot, navegue até CRM > Listas.
- Clique no nome de uma lista.
- No canto superior direito, clique em Detalhes.
- No painel direito, o ID da lista aparecerá em Listar IDs para integrações de API. Você pode clicar em Copiar ID da lista para copiar o ID para a área de transferência.
À medida que você associa listas aos seus eventos de marketing, elas aparecerão na página de detalhes de um evento de marketing na sua conta HubSpot:
- Na sua conta HubSpot, navegue até CRM > Contatos.
- No canto superior esquerdo, clique Contatos e no menu suspenso, selecione Eventos de marketing.
- Clique no nome de um evento de marketing.
- Na aba Desempenho, clique em Listas para expandir a seção, clique em Listas adicionadas por meio de associações aba.
Para criar uma nova associação entre um evento de marketing e uma lista existente, faça um pedido PUT
para /marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}
.
Se for bem-sucedido, você receberá uma resposta 204 No content
.
Para criar uma nova associação entre um evento de marketing e uma lista existente usando o ID da conta externa e o ID do evento externo, faça um pedido PUT
para /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}
.
Se for bem-sucedido, você receberá uma resposta 204 No content
.
Obtenha listas associadas a um evento de marketing usando uma ID de evento de marketing
Para obter todas as listas associadas a um evento de marketing, faça um pedido GET
para /marketing/v3/marketing-events/associations/{marketingEventId}/lists
.
A resposta será semelhante à seguinte:
{
"total": 1,
"results": [
{
"listId": "string",
"listVersion": 0,
"createdAt": "2024-05-10T08:58:35.769Z",
"updatedAt": "2024-05-10T08:58:35.769Z",
"filtersUpdatedAt": "2024-05-10T08:58:35.769Z",
"processingStatus": "string",
"createdById": "string",
"updatedById": "string",
"processingType": "string",
"objectTypeId": "string",
"name": "string",
"size": 0
}
]
}
Obtenha listas associadas a um evento usando IDs de eventos e contas externas
Você também pode obter listas associadas a um evento de marketing usando uma ID de conta externa e a ID do evento externo, faça um pedido GET
para /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists
.
Excluir associação de lista usando um ID de evento de marketing
Para excluir uma associação de lista para um evento de marketing usando uma ID de evento de marketing, faça um pedido DELETE
para /marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}
.
Se for bem-sucedido, você receberá uma resposta 204 No content
.
Excluir associação de lista usando IDs de eventos e contas externas
Para excluir uma associação de lista para um evento de marketing usando a ID da conta externa e uma ID de evento externo, faça um pedido DELETE
para /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}
.
Se for bem-sucedido, você receberá uma resposta 204 No content
.
Configurações do aplicativo
Algumas configurações são necessárias para permitir que os eventos de marketing sejam sincronizados corretamente com a HubSpot.
Se você enviar à HubSpot uma alteração de estado de presença (por exemplo, uma inscrição ou cancelamento), a HubSpot primeiro verificará se existe um Evento de Marketing para o ID de evento especificado. Caso contrário, a HubSpot chamará o ponto de extremidade configurado do seu app para recuperar os detalhes do evento de marketing e, então, criar o evento na HubSpot e publicar a alteração do estado da presença.
Isso é fornecido para sua conveniência; no entanto, ainda é recomendável que você crie os Eventos de Marketing por meio dos métodos CRUD fornecidos no documentação de referência e não confie nessa funcionalidade para criar seus eventos de marketing no HubSpot.
Etapa 1: crie uma API em seu aplicativo
Para oferecer suporte a isso, o HubSpot exige que cada app que usa eventos de marketing defina uma API para obter informações sobre um evento de marketing específico.
Requisitos:
- Aceita:
externalAccountId
: um parâmetro de consulta que especifica o accountId do cliente no aplicativo externo.
appId
: um parâmetro de consulta que especifica o ID do aplicativo HubSpot que está solicitando os detalhes do evento. Este será o ID do seu app.
externalEventId
: um parâmetro de caminho na URL da solicitação que especifica o ID do evento no aplicativo externo sobre o qual o HubSpot requer detalhes.
- Retorna:
- Um objeto JSON que fornece detalhes para o evento de marketing, que inclui os seguintes campos detalhados na tabela abaixo:
| Nome do campo | Obrigatório | Tipo | Campo descrição |
| ------------------ | ----------- | ------------------ | ------------------------------------------------------------------------------------ | --- |
| eventName
| true | string | O nome do evento de marketing. |
| eventOrganizer
| true | string | O nome do organizador do evento de marketing. |
| eventType
| false | string | Descreve que tipo de evento é este. Por exemplo, WEBINAR
, CONFERENCE
, WORKSHOP
| . |
| startDateTime
| false | string(date−time)∣Adataehoradeinıˊciodoeventodemarketing.∣∣‘endDateTime‘∣false∣string(date-time) | A data e hora de término do evento de marketing. |
| eventDescription
| false | string | A descrição do evento de marketing. |
| eventUrl
| false | string | Um URL no aplicativo de evento externo no evento de marketing. |
| eventCancelled
| false | bool | indica se o evento de marketing foi cancelado. Assume o padrão false
| . |
A HubSpot também enviará um cabeçalho X-HubSpot-Signature-v3
que você pode usar para verificar se a solicitação veio da HubSpot. Leia mais sobre request signatures para obter detalhes adicionais sobre a assinatura e como validá-la.
Etapa 2: Fornecer à HubSpot o caminho da URL para sua API
Agora que você criou a API em seu app que retornará um objeto que fornece os detalhes de um evento de marketing específico, você vai precisar fornecer à HubSpot o caminho de URL para sua API fazendo uma solicitação POST
para /marketing/v3/marketing-events/{appId}/settings
. Isso permitirá que a HubSpot determine como fazer solicitações ao seu app para obter os detalhes de um evento de marketing.
No corpo de sua solicitação POST
, especifique sua URL usando o campo eventDetailsURL
. A eventDetailsURL
deve atender aos dois requisitos a seguir:
- Conter uma sequência de caracteres
%s
que a HubSpot usará para substituir no ID do evento (externalEventId
) como um parâmetro de caminho.
- Deve ser o caminho completo para o recurso da API, incluindo o prefixo
https://
e o nome do domínio (por exemplo, my.event.app
).
Por exemplo, se você configurar um eventDetailsURL
dehttps://my.event.app/events/%s
e precisar fazer uma solicitação para obter detalhes de um evento com id 1234-event-XYZ
para o aplicativo HubSpot com o id app-101
e conta com o id ABC-account-789
, o HubSpot fará uma solicitação GET
para:
https://my.event.app/events/1234-event-XYZ?appId=app-101&externalAccountId=ABC-account-789