Información general sobre el objeto de eventos de marketing de HubSpot.
crm.objects.marketing_events.read
: da permiso para obtener datos de eventos de marketing y asistencia.crm.objects.marketing_events.write
: da permisos para crear, eliminar o hacer cambios en la información de eventos de marketing.externalEventId
y externalAccountId
solo funcionarán en la misma aplicación que creó originalmente el evento. Por ejemplo, si has creado dos aplicaciones públicas, denominadas App A y App B, y has creado un evento de marketing mediante la autenticación y los ID asociados a App A, solo App B puede leer, cambiar y añadir nuevos participantes al evento. Si intentas acceder al mismo evento con App B utilizando los mismos externalEventId y externalAccountId, se producirá un error 404.objectId
pueden usarse para acceder a un evento por cualquier aplicación con los permisos asociados que se mencionan en la sección anterior, independientemente de la aplicación que creó originalmente el evento. Si App A creó un evento de marketing, App B puede seguir leyendo, actualizando o añadiendo participantes a través de endpoints basados en el objectId
.Parámetro | Tipo | Descripción |
---|---|---|
eventName | Cadena | El título del evento. |
eventType | Cadena | El tipo de evento (ejemplo, webinario, feria comercial, etc.). |
eventOrganizer | Cadena | La persona o la organización a cargo del evento. |
eventDescription | Cadena | Una descripción del evento. |
eventUrl | Cadena | Una URL a la que los usuarios pueden navegar para registrarse al evento o conocer más información. |
eventCancelled | Booleano | Si el evento está cancelado o no. |
eventStartTime | Cadena | Una marca de tiempo con el formato ISO 8601 de la hora de inicio del evento. |
eventEndTime | Cadena | Una marca de tiempo con el formato ISO 8601 de la hora de finalización del evento. |
POST
a /marketing/v3/marketing-events/events
e incluir los datos eventName
, externalEventId
, externalAccountId
y eventOrganizer
en el cuerpo de la solicitud. Si quieres, puedes indicar en tu solicitud las propiedades adicionales que figuran en la tabla anterior.
Por ejemplo, si el externalAccountId
de tu app es "12345"
y el externalEventId
de tu evento en la app es "67890"
, podrías crear un nuevo evento llamado "Winter webinar"
con una solicitud que se parecería a la siguiente:
POST
al endpoint /marketing/v3/marketing-events/events/upsert
. Puedes incluir cualquier customProperties
propiedad personalizada junto con cualquier otro detalle del evento (como su nombre, hora de inicio y descripción).
Si ya hay un evento de marketing con el ID especificado en tu solicitud, se actualizará. De lo contrario, se creará un nuevo evento.
Por ejemplo, la siguiente solicitud crearía un evento con el ID 4
llamado “Virtual cooking class”:
PATCH
a /marketing/v3/marketing-events/{objectId}
.
objectId
de un evento de marketing específico, sigue las instrucciones de este artículo de la base de conocimientos para ver los detalles del evento en tu cuenta de HubSpot y luego, localiza el ID en el campo Record ID. La dirección objectId
también se devolverá en la respuesta cuando se cree un evento correctamente.GET
al punto de terminación /marketing/v3/marketing-events
descrito en la siguiente sección.externalEventId
de un evento, puedes incluirla como ruta al hacer una solicitud GET
a /marketing/v3/marketing-events/{externalEventId}/identifiers
. La respuesta incluirá todos los eventos de marketing junto con los identificadores pertinentes de cada evento (es decir, el objectId
del evento, su appInfo
, el marketingEventName
, y el externalAccountId
).GET
a /marketing/v3/marketing-events
.
Si necesitas obtener los detalles de un evento de marketing específico por el Record ID de HubSpot, puedes proporcionar el ID como objectId en una solicitud GET
a /marketing/v3/marketing-events/{objectId}
.
DELETE
a /marketing/v3/marketing-events/{objectId}
con la dirección objectId
asociada al evento.
Si tiene éxito, recibirás una respuesta 204 No Content
.
POST
a /marketing-events/v3/marketing-events/batch/update
y proporcionar las propiedades que quieres actualizar en cada evento dentro de la matriz de entradas del cuerpo de la solicitud.
Por ejemplo, si quieres actualizar varias propiedades de dos eventos de marketing con los ID de objeto 58237132332 y 54073507364 en una única solicitud, el cuerpo de la solicitud sería similar al siguiente:
objectId
de un evento de email marketing, puedes utilizar el ID de contacto del contacto para el que quieres registrar el estado de participación, o bien puedes utilizar su dirección de email.
/marketing/v3/marketing-events/{objectId}/attendance/{subscribeState}/create
y, a continuación, proporciona el ID del contacto utilizando el campo vid
dentro de la matriz inputs
del cuerpo de la solicitud. Por ejemplo, el cuerpo de la solicitud que se muestra a continuación proporciona un ejemplo de actualización de los datos de asistencia de un contacto con un ID 47733471576
y especifica cuándo el asistente entró y salió del evento mediante las propiedades joinedAt
y leftAt
:/marketing/v3/marketing-events/{objectId}/attendance/{subscribeState}/email-create
y, a continuación, proporciona el correo electrónico del contacto utilizando el campo email
dentro de la matriz inputs
del cuerpo de la solicitud.
contactProperties
dentro de la matriz inputs
del cuerpo de la solicitud para definir cualquier propiedad asociada en el contacto recién creado. De lo contrario, si el contacto ya existe, el valor contactProperties
, proporcionado en la solicitud, no se actualizará .john@example.com
, y especifica cuándo el asistente entró y salió del evento en de los campos joinedAt
y leftAt
dentro del objeto properties
de la matriz inputs
:objectId
: el Record ID del evento de marketing en tu cuenta de HubSpot. Consulta la sección anterior para obtener más detalles sobre el uso de objectId de un evento frente al uso de sus ID externos.subscriberState
: una enumeración que coincide con el nuevo estado de asistencia del contacto:REGISTERED
: indica que el contacto de HubSpot se registró en el evento.ATTENDED
: indica que el contacto de HubSpot asistió al evento. Si estás actualizando el estado de un contacto a ATTENDED, también puedes incluir las marcas de tiempo joinedAt
y leftAt
como parámetros en el cuerpo de la solicitud, especificados en el formato ISO8601 Instant.CANCELLED
: indica que el contacto de HubSpot, que se había registrado previamente en el evento, ha cancelado su registro./upsert
o /email-upsert
para actualizar el estado de un asistente, puedes utilizar en su lugar los endpoints que se indican a continuación. Sin embargo, en comparación con los endpoints de asistencia a eventos anteriores, el uso de estos endpoints no permitirá hacer lo siguiente:joinedAt
o leftAt
.externalEventId
de la aplicación, puedes utilizar los ID de contacto o la dirección de correo electrónico de los contactos existentes:
POST
a /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create
, utilizando el ID del evento desde tu aplicación externa como el externalEventId
.inputs
que incluya los siguientes campos:
interactionDateTime
: la fecha y la hora en las que el contacto se suscribió al evento.vid
: el ID de contacto de un contacto existente.POST
a /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create
.inputs
que incluya los siguientes campos:
interactionDateTime
: la fecha y la hora en las que el contacto se suscribió al evento.email
: la dirección de correo electrónico del asistente como el valor del campo de correo electrónico dentro de una entrada.externalEventId
: el ID del evento de marketing. Consulta la sección anterior para obtener más detalles sobre el uso de objectId de un evento frente al uso de sus ID externos.subscriberState
: una enumeración que coincide con el nuevo estado de asistencia del contacto:
REGISTERED
: indica que el contacto de HubSpot se registró en el evento.ATTENDED
: indica que el contacto de HubSpot asistió al evento. Si estás actualizando el estado de un contacto a ATTENDED, también puedes incluir las marcas de tiempo joinedAt
y leftAt
como parámetros en el cuerpo de la solicitud, especificados en el formato ISO8601 Instant.CANCELLED
: indica que el contacto de HubSpot, que se había registrado previamente en el evento, ha cancelado su registro.interactionDateTime
del evento no cambien. Así, puedes configurar de forma segura el estado de asistencia varias veces sin que HubSpot cree eventos duplicados en las propiedades de eventos de marketing.attended
, registered
, cancelled
o noShows
).GET
a /marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown
, utilizando el ID o la dirección de correo electrónico del contacto como parámetro de ruta contactIdentifier
.
La respuesta incluirá un resumen de la participación del contacto en el evento, en el campo properties
:
externalAccountId
y el externalEventId
del evento para hacer una solicitud GET
a /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown
.
externalAccountId
y el externalEventId
del evento para hacer una solicitud GET
a /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}
.
La respuesta incluirá los recuentos totales de asistencia:
Parámetro de consulta | Tipo | Descripción |
---|---|---|
contactIdentifier | Cadena | La dirección de correo electrónico o el ID de un contacto específico |
state | Enumeración | El estado de participación del evento. Los estados de participación son:
|
limit | Número | El límite de los resultados devueltos. De forma predeterminada, el límite se define como 10. El intervalo válido es de 1 a 100. |
after | Número | Se utiliza para la paginación entre los resultados de la respuesta. Consulta la información proporcionada en la página anterior de datos de respuesta para determinar el próximo índice de resultados que se devolverá. |
listId
como parámetro de ruta, que puedes encontrar en la página de detalles de la lista en tu cuenta de HubSpot:
PUT
a /marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}
.
Si tiene éxito, recibirás una respuesta 204 No content
.
PUT
a /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}
.
Si tiene éxito, recibirás una respuesta 204 No content
.
GET
a /marketing/v3/marketing-events/associations/{marketingEventId}/lists
.
La respuesta tendrá el siguiente formato:
GET
a /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists
.
DELETE
a /marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}
.
Si tiene éxito, recibirás una respuesta 204 No content
.
DELETE
a /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}
.
Si tiene éxito, recibirás una respuesta 204 No content
.
externalAccountId
: un parámetro de consulta que especifica el accountId del cliente en la aplicación externa.appId
: un parámetro de consulta que especifica el ID de la aplicación de HubSpot que solicita los detalles del evento. Este será el ID de tu aplicación.externalEventId
: un parámetro de ruta en la URL de la solicitud que especifica el ID del evento en la aplicación externa sobre la que HubSpot requiere detalles.eventName
| verdadero | cadena | El nombre del evento de marketing |
| eventOrganizer
| verdadero | cadena | El nombre del organizador del evento de marketing. |
| eventType
| falso | cadena | Describe qué tipo de evento es este. Por ejemplo, WEBINAR
, CONFERENCE
, WORKSHOP
| . |
| startDateTime
| falso | cadena (fecha y hora) | La fecha y la hora de inicio del evento de marketing. |
| endDateTime
| falso | cadena (fecha y hora) | La fecha y la hora de finalización del evento de marketing. |
| eventDescription
| falso | cadena (fecha y hora) | La descripción del evento de marketing. |
| eventUrl
| falso | cadena (fecha y hora) | Una URL en la aplicación del evento externo donde se realiza el evento de marketing. |
| eventCancelled
| falso | boolenano | Indica si el evento de marketing se canceló. El valor predeterminado es false
|
HubSpot también enviará un encabezado X-HubSpot-Signature-v3
que puedes usar para verificar que la solicitud proviene de HubSpot. Consulta información sobre las firmas de solicitud para obtener detalles adicionales sobre la firma y cómo validarla.
POST
a /marketing/v3/marketing-events/{appId}/settings
. Esto permitirá a HubSpot determinar cómo realizar solicitudes a tu aplicación para obtener los detalles de un evento de marketing.
En el cuerpo de tu solicitud POST
, especifica la URL utilizando el campo eventDetailsURL
. El eventDetailsURL
debe cumplir con los siguientes requisitos:
%s
, que HubSpot utilizará para hacer la substitución en el ID del evento (externalEventId
) como parámetro de ruta.https://
y el nombre de dominio (por ejemplo, my.event.app
).eventDetailsURL
de https://my.event.app/events/%s
y necesitas hacer una solicitud para obtener detalles de un evento con el ID 1234-event-XYZ
, de la aplicación HubSpot con el ID app-101
y la cuenta con el ID ABC-account-789
, HubSpot hará una solicitud GET
a:
https://my.event.app/events/1234-event-XYZ?appId=app-101&externalAccountId=ABC-account-789