Pular para o conteúdo principal
GET
Obter uma instância de evento

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Scopes

crm.objects.contacts.highly_sensitive.read.v2
crm.schemas.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.read
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.read
crm.schemas.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.deals.highly_sensitive.read.v2
crm.schemas.deals.read
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
tickets.sensitive.v2
crm.objects.tickets.sensitive.read
crm.objects.tickets.highly_sensitive.read
tickets.highly_sensitive.v2

Parâmetros de caminho

eventId
string
obrigatório
eventTemplateId
string
obrigatório

Resposta

successful operation

eventTemplateId
string
obrigatório

O ID do modelo do evento.

id
string
obrigatório

Identificador do evento. Deve ser exclusivo para o aplicativo e modelo de evento. Se você usar o mesmo ID para diferentes objetos do CRM, o último a ser processado prevalecerá e o primeiro não terá um registro. Você também pode usar "{{uuid}}" em qualquer lugar no ID para gerar uma string única, garantindo a exclusividade.

objectType
string
obrigatório

O ObjectType associado a EventTemplate.

tokens
object
obrigatório

Uma coleção de chaves de token e valores associados aos tokens do modelo.

createdAt
string<date-time>

Não usado.

customObjectTypeId
string
domain
string

O domínio do evento (frequentemente pareado com o utk).

email
string

O endereço de e-mail usado para eventos específicos de contato. Pode ser usado para identificar contatos existentes, criar novos contatos ou alterar o e-mail de um contato existente (se estiver pareado com o "objectId").

extraData
object

Dados adicionais específicos do evento que podem ser interpretados pelo markdown do modelo.

objectId
string

O identificador do objeto do CRM. É necessário para todos os eventos, exceto contatos (nos quais o utk ou o e-mail podem ser usados).

timelineIFrame
object
timestamp
string<date-time>

A hora em que o evento ocorreu. Se não for transmitido, a hora atual será usada. É usado para determinar onde um evento é mostrado na linha do tempo de um objeto do CRM.

utk
string

Use o parâmetro "utk" para associar um evento com um contato pelo "usertoken". É recomendado fazer isso se você não souber o e-mail de um usuário, mas tiver um token de identificação do usuário em seus cookies.

Última modificação em 6 de outubro de 2026