Create an event subscription

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

appId

integer<int32>

obrigatório

O identificador do aplicativo.

Corpo

application/json

active

boolean

obrigatório

Um booleano que indica se a assinatura está ativa.

eventType

enum<string>

obrigatório

Uma string que representa o tipo de evento a ser assinado. Os valores válidos incluem várias alterações de propriedade, criações, exclusões, fusões, restaurações, alterações de associação e conclusões de eventos.

Opções disponíveis:

company.associationChange,

company.creation,

company.deletion,

company.merge,

company.propertyChange,

company.restore,

contact.associationChange,

contact.creation,

contact.deletion,

contact.merge,

contact.privacyDeletion,

contact.propertyChange,

contact.restore,

conversation.creation,

conversation.deletion,

conversation.newMessage,

conversation.privacyDeletion,

conversation.propertyChange,

deal.associationChange,

deal.creation,

deal.deletion,

deal.merge,

deal.propertyChange,

deal.restore,

event.completed,

line_item.associationChange,

line_item.creation,

line_item.deletion,

line_item.merge,

line_item.propertyChange,

line_item.restore,

object.associationChange,

object.creation,

object.deletion,

object.merge,

object.propertyChange,

object.restore,

product.creation,

product.deletion,

product.merge,

product.propertyChange,

product.restore,

ticket.associationChange,

ticket.creation,

ticket.deletion,

ticket.merge,

ticket.propertyChange,

ticket.restore

eventTypeName

string

Uma string que fornece um nome legível para o tipo de evento.

objectTypeId

string

Uma string que representa o ID do tipo de objeto associado à assinatura.

propertyName

string

Uma string que indica o nome da propriedade específica relacionada ao tipo de evento, se aplicável.

Resposta

successful operation

active

boolean

obrigatório

Um booleano que indica se a assinatura está ativa no momento.

createdAt

string<date-time>

obrigatório

A data e hora em que a assinatura foi criada, no formato ISO 8601.

eventType

enum<string>

obrigatório

O tipo de evento que aciona a assinatura. Os valores válidos incluem várias alterações de propriedade, criações, exclusões, fusões, restaurações e alterações de associação para diferentes objetos do HubSpot.

Opções disponíveis:

company.associationChange,

company.creation,

company.deletion,

company.merge,

company.propertyChange,

company.restore,

contact.associationChange,

contact.creation,

contact.deletion,

contact.merge,

contact.privacyDeletion,

contact.propertyChange,

contact.restore,

conversation.creation,

conversation.deletion,

conversation.newMessage,

conversation.privacyDeletion,

conversation.propertyChange,

deal.associationChange,

deal.creation,

deal.deletion,

deal.merge,

deal.propertyChange,

deal.restore,

event.completed,

line_item.associationChange,

line_item.creation,

line_item.deletion,

line_item.merge,

line_item.propertyChange,

line_item.restore,

object.associationChange,

object.creation,

object.deletion,

object.merge,

object.propertyChange,

object.restore,

product.creation,

product.deletion,

product.merge,

product.propertyChange,

product.restore,

ticket.associationChange,

ticket.creation,

ticket.deletion,

ticket.merge,

ticket.propertyChange,

ticket.restore

string

obrigatório

O identificador exclusivo da assinatura. É um número inteiro formatado como int64.

eventTypeName

string

O nome do tipo de evento para a assinatura.

objectTypeId

string

O identificador para o tipo de objeto associado à assinatura. É uma string.

propertyName

string

O nome da propriedade associada ao evento de assinatura, se aplicável.

updatedAt

string<date-time>

A data e a hora da última atualização da assinatura, no formato ISO 8601.