Visão geral e passo a passo sobre a API da Linha do tempo.
objectType
. Para obter mais informações, veja a criação de um modelo de evento de linha do tempo.
Cada modelo de evento tem seu próprio conjunto de tokens e modelos. Você pode usar eventos criados para contatos como critérios ao criar novas listas de contatos ou fluxos de trabalho, como: “Create a list of all contacts with a Video Like where the video name contains XYZ”, onde o nome do modelo de evento é “Video Like” e tem um token de evento denominado “video name”.
<appId>
pelo ID do próprio aplicativo, que pode ser encontrado nas páginas Meus aplicativos e Detalhes do aplicativo em sua conta do desenvolvedor. Você também precisará substituir <developerHapikey>
por sua própria chave de API de desenvolvedor; ela pode ser encontrada em Aplicativos > Receber a chave de API da HubSpot.
As propriedades headerTemplate
e detailTemplate
também podem ser fornecidas aqui. Para mais informações, consulte Definir modelos de cabeçalho e detalhes abaixo.
Essa solicitação POST
retornará a definição completa do modelo de evento salvo. Observe a propriedade id
nessa resposta. Este é o ID do modelo de evento; ele será necessário caso você precise fazer qualquer atualização nesse modelo de evento ou em tokens no futuro.
Você pode ver todos os modelos de evento definidos para um aplicativo usando esse comando GET, que também retornará os ID do modelo de evento:
GET
retornará todos os tokens definidos em um modelo de evento:
string
number
enumeration
— Uma dentre um conjunto de opções. Veja o exemplo webinarType abaixo.date
— Todas as datas devem estar em milissegundos no horário do Unix.webinarName
no modelo usando {{webinarName}}
.
O extraData
de um evento (analisado em “Noções básicas sobre extraData” abaixo) pode ser referenciado apenas no modelo de detalhes.
PUT
:
#formatDate
. Definimos essa diretiva para permitir uma formatação de data de fácil compreensão para o usuário.
Assim que um evento for criado para um contato usando essa diretiva (consulte “Criando um evento” abaixo), veja o que será exibido na linha do tempo do contato:
POST
.
contacts
criado acima. Se o modelo de evento acima não estiver configurado para ter os tokens webinarName
e webinarId
, você receberá um erro ao tentar criar o evento. Este é um exemplo do comando POST
para a criação de um evento:
a.test.contact@email.com
’ (considerando os modelos descritos em “Definindo modelos” acima):
vid
do contato para associar o evento. Nesses casos, você usaria objectId
no JSON da solicitação. Você precisa incluir o vid de um contato existente, pois você não poderá criar novos contatos usando objectId
. Este exemplo usa o objectId
, em vez do e-mail:
utk
. Usertoken é usado pelo código de rastreamento da HubSpot para rastrear visitantes e é armazenado no cookie hubspotutk
. Use o parâmetro utk
para associar um evento a um contato por usertoken. Observação: não é possível associar eventos a visitantes anônimos usando usertoken. Portanto, se o evento estiver associado somente ao parâmetro utk
e o usertoken fornecido não estiver associado a um contato ainda, nenhum novo contato será criado, e o evento não estará visível no HubSpot. No entanto, o evento aparecerá na linha do tempo se um novo contato tiver sido associado ao usertoken de outra maneira (geralmente por meio de um envio de formulário incluindo hutk ou por meio do método de identificação da API do código de rastreamento). Por isso, recomendamos que você inclua o email
, além do utk
, para garantir que o evento seja associado a um contato novo ou existente.
Se você estiver trabalhando com um modelo de evento para contatos, poderá incluir vários parâmetros de identificação com o evento para que seja possível incluir qualquer combinação dos parâmetros email
, objectId
e utk
. Se vários parâmetros forem incluídos, o parâmetro objectId (vid) prevalecerá no momento de determinar qual contato deve ser associado ao evento, seguido do parâmetro utk
. O parâmetro email
é o de menor prioridade. Isso significa que você pode atualizar o endereço de e-mail de um objeto existente, incluindo um novo endereço de e-mail no parâmetro email
email com vid
de um objeto conhecido em objectId
. Este exemplo usa o endereço de e-mail e o token de usuário juntos:
objectId
para associar o evento à empresa ou ao negócio. Para empresas, objectId
deve ser definido com o companyId
da empresa a que você deseja associar o evento; para negócios, objectId
deve ser definido com o dealId
do objeto de negócios.
No exemplo abaixo, considerando que o modelo de evento foi definido como objectType
COMPANY
, esse evento seria associado ao objeto de empresa com companyId
528253914:
linkLabel
O texto usado para mostrar o link que exibirá o IFrame.headerLabel
O rótulo da janela modal que exibe o conteúdo do IFrame.url
O URI do conteúdo do IFrame.width
A largura da janela modal.height
Height - A altura da janela modal.url
:
PUT
para atualizar um modelo de evento personalizado. Observe o campo objectPropertyName
:
objectPropertyName
para mapear esse token de evento personalizado à propriedade zz_webinar_name
do objeto contact
. Isso significa que, quando criamos um novo evento que especifica um webinarName
, a propriedade zz_webinar_name
do contact
associado também é definida. Você pode definir essas propriedades para propriedades personalizadas ou predefinidas do HubSpot.
Por exemplo, suponha que já tenhamos criado um token companyName
que faça referência a uma propriedade personalizada zz_company_name
. Em seguida, a criação de um evento como este faz com que as propriedades zz_company_name
e zz_webinar_name
sejam definidas no contato com o endereço de e-mail a.test.contact@email.com:
extraData
extraData
.
Você pode adicionar um atributo extraData
ao corpo JSON do evento. O valor desse extraData
pode ser qualquer JSON válido. Por exemplo:
extraData
em um modelo de detalhes:
extraData
só pode ser referenciado no modelo de detalhes de um evento. Ele não pode ser usado no modelo de cabeçalho nem na segmentação de lista.