Pular para o conteúdo principal
POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
Criar uma assinatura de evento
curl --request POST \
  --url 'https://api.hubapi.com/webhooks/v3/{appId}/subscriptions?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "eventType": "contact.propertyChange",
  "propertyName": "email"
}
'
{
  "active": true,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "eventType": "contact.propertyChange",
  "id": "12",
  "propertyName": "email",
  "updatedAt": "2019-11-30T03:30:17.883Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubStarter

Autorizações

​
hapikey
string
query
obrigatório

Parâmetros de caminho

​
appId
integer<int32>
obrigatório

O ID do aplicativo de destino.

Corpo

application/json

Details about the new subscription.

Request to create a new webhook subscription for monitoring specific events. Each subscription defines which event type to listen for and whether to monitor all events of that type or specific property changes.

​
eventType
enum<string>
obrigatório

O tipo de evento a ser monitorado. Pode ser "create", "delete", "deletedForPrivacy" ou "propertyChange".

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
​
active
boolean

Determina se a assinatura está ativa ou pausada. Assume o padrão falso.

​
eventTypeName
string

O nome do evento a ser monitorado. Isso é usado com objetos personalizados para especificar tipos de eventos personalizados além dos valores padrão de enumeração eventType.

​
objectTypeId
string

O ID do objeto para a assinatura. Pode ser um objeto dp CRM padrão (por exemplo, "contato", "registro de empresa", "negócio") ou um ID de objeto personalizado para assinaturas de objetos personalizados.

​
propertyName
string

O nome interno da propriedade a ser monitorada para alterações. Somente se aplica quando "eventType" é "propertyChange".

Resposta

successful operation

Complete details for an event subscription.

​
active
boolean
obrigatório

Indica se a assinatura está ativa ou pausada. Se for "true", a assinatura enviará notificações de webhook. Se for "false", a assinatura será pausada e não enviará notificações.

​
createdAt
string<date-time>
obrigatório

A data/hora em que a assinatura do webhook foi criada, no formato ISO 8601 (por exemplo, 2020-02-29T12:30:00Z).

​
eventType
enum<string>
obrigatório

O tipo de evento a ser monitorado. Os valores aceitos incluem contact.creation, contact.deletion, contact.propertyChange e tipos de evento semelhantes para outros objetos de CRM e objetos personalizados.

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
​
id
string
obrigatório

O ID exclusivo da assinatura do webhook.

​
eventTypeName
string

O nome do evento a ser monitorado. Isso é usado com objetos personalizados para especificar tipos de eventos personalizados além dos valores padrão de enumeração eventType.

​
objectTypeId
string

O ID do objeto para a assinatura. Pode ser um objeto dp CRM padrão (por exemplo, "contato", "registro de empresa", "negócio") ou um ID de objeto personalizado para assinaturas de objetos personalizados.

​
propertyName
string

O nome interno da propriedade a ser monitorada quanto a alterações. Somente se aplica quando eventType é propertyChange.

​
updatedAt
string<date-time>

A data/hora da última atualização da assinatura do webhook, no formato ISO 8601 (por exemplo, 2020-02-29T12:30:00Z).

Last modified on January 23, 2026