Resumen y guía de la API de la cronología.
objectType
. Puedes encontrar más información en la sección de la creación de una plantilla de evento de cronología.
Cada plantilla de evento tiene su propio conjunto de tokens y plantillas. Puedes usar eventos creados para contactos como criterio al crear listas o workflows para contactos nuevos, tales como ‘Crear una lista de todos los contactos con un video similar cuyo nombre contenga las letras XYZ’, en el que la plantilla de video se denomina “Video similar” y tiene un token de evento denominado “Nombre del video”.”
<appId>
con el ID de tu aplicación, este se puede encontrar tanto en las páginas de Mis aplicaciones como en las de detalles de la aplicación en tu cuenta de desarrollador. También tendrás que reemplazar <developerHapikey>
con tu clave de API de desarrollador, que puedes encontrar en Aplicaciones > Obtener clave de API de HubSpot.
Las propiedades headerTemplate
y detailTemplate
también se pueden encuentran aquí. Para más información, consulta la sección Definir las plantillas de encabezado y detalle a continuación.
Esta solicitud POST
devolverá la definición completa de la plantilla de eventos guardada. Asegúrate de tener en cuenta la propiedad id
en esta respuesta. Este es el ID de la plantilla de eventos, que necesitarás para hacer cualquier actualización de esta plantilla o tokens de evento en el futuro.
Puedes ver todas las plantillas de eventos para una aplicación mediante el comando GET, que también devolverá los ID de las plantillas de eventos:
GET
devolverá todos los tokens definidos en una plantilla de evento:
string
number
enumeration
— Una de un conjunto de opciones. Consulta el ejemplo anterior de webinarType.date
— Todas las fechas deben estar en milisegundos en tiempo Unix.webinarName
en la plantilla usando {{webinarName}}
El extraData
de un evento (que se describe más adelante en “Comprender extraData”) solo se puede referenciar en la plantilla de detalles.
PUT
:
#formatDate
es algo que hemos definido para permitir un formato de fecha fácil de usar.
Una vez que se crea un evento para un contacto usando esto (ver “Creación de un evento” abajo), esto es lo que se mostrará en la cronología del contacto:
POST
.
contacts
creada anteriormente. Si la plantilla de evento anterior no está configurada para tener los tokens webinarName
y webinarId
, recibirás un error al intentar crear el evento. Aquí tienes un ejemplo de solicitud POST
para crear un evento:
a.test.contact@email.com
(suponiendo que se usan las plantillas de la sección anterior ‘Definición de plantillas’):
vid
de contacto para asociar el evento. En esos casos, usarías objectId
en la solicitud JSON. Debes incluir el vid de un contacto existente, ya que no podrás crear nuevos contactos usando objectId
. En este ejemplo, se utiliza el objectId
en lugar del correo electrónico:
utk
. El usertoken es usado por el código de seguimiento de HubSpot para hacer seguimiento a los visitantes y se almacena en la cookie hubspotutk
. Usa el parámetro utk
para asociar un evento a un contacto por usertoken. Ten en cuenta que no es posible asociar eventos con visitantes anónimos usando el usertoken. Si el evento solo está asociado con el utk
y el usertoken proporcionado no está asociado con un contacto, no se creará un nuevo contacto y el evento no será visible en HubSpot. Sin embargo, el evento aparecerá en la cronología si un nuevo contacto se asoció con el usertoken a través de otro medio (generalmente a través de un envío de formulario incluido el hutk o a través del método de identificación de la API del código de seguimiento). Por esta razón, recomendamos incluir el email
además del utk
para asegurarnos de que el evento se asocia con un contacto nuevo o existente.
Si estás trabajando con una plantilla de evento para contactos, es posible incluir varios parámetros de identificación con el evento, por lo que cualquier combinación de los parámetros email
, objectId
y utk
puede incluirse. Si se incluyen varios parámetros, el objectId (vid) tendrá mayor prioridad al determinar qué contacto asociar con el evento, seguido de utk
y luego email
con la prioridad más baja. Esto significa que puedes actualizar la dirección de correo electrónico de un objeto existente incluyendo una nueva dirección de correo electrónico en el parámetro email
con la vid
de un objeto conocido en objectId
. Este ejemplo usa la dirección de correo electrónico y el usertoken:
objectId
para asociar el evento con la empresa o negocio. Para empresas, el objectId
debe establecerse con el companyId
de la empresa con la que deseas asociar el evento, y para negocios debes establecer objectId
con el dealId
del objeto del negocio.
En el siguiente ejemplo, suponiendo que la plantilla de evento se configuró en el objectType
COMPANY
, este evento se asociaría con el objeto de la empresa con companyId
528253914:
linkLabel
: el texto utilizado para mostrar el enlace que mostrará el IFrame.headerLabel
: la etiqueta de la ventana modal que muestra el contenido del IFrame.url
: la URI del contenido del IFrame.width
: el ancho de la ventana modal.height
: la altura de la ventana modal.url
:
PUT
para actualizar una plantilla de evento personalizada, ten en cuenta el campo objectPropertyName
:
objectPropertyName
para asignar el token del evento personalizado a la propiedad zz_webinar_name
del objeto contact
. Esto significa que cuando creamos un nuevo evento que especifique el token webinarName
, también se establecerá la propiedad zz_webinar_name
del contact
asociado. Puedes establecer estas propiedades de HubSpot como personalizadas o predefinidas.
Por ejemplo, supongamos que ya creamos el token companyName
que hace referencia a la propiedad personalizada zz_company_name
en el contacto. La creación de un evento como este hace que se establezcan las propiedades zz_company_name
y zz_webinar_name
en el contacto con la dirección de correo electrónico a.test.contact@email.com:
extraData
extraData
.
Puedes agregar un atributo extraData
al cuerpo JSON de un evento. El valor de extraData
puede ser cualquier JSON válido. Por ejemplo:
extraData
en una plantilla de detalles:
extraData
en la plantilla de detalles de un evento. No se puede usar ni en la plantilla de encabezado ni en la segmentación de listas.