Zum Hauptinhalt springen
POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
Criar uma assinatura de evento
curl --request POST \
  --url https://api.hubapi.com/webhooks/v3/{appId}/subscriptions \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true,
  "eventType": "contact.propertyChange",
  "propertyName": "email"
}'
{
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "eventType": "company.associationChange",
  "id": "<string>",
  "objectTypeId": "<string>",
  "propertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

O ID do aplicativo.

Body

application/json

New webhook settings for an app.

​
eventType
enum<string>
required

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

Verfügbare Optionen:
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,
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.

​
objectTypeId
string
​
propertyName
string

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

Response

successful operation

Complete details for an event subscription.

​
active
boolean
required

Determina se a assinatura está ativa ou pausada.

​
createdAt
string<date-time>
required

Quando esta assinatura foi criada. Formatado como milissegundos a partir de era Unix.

​
eventType
enum<string>
required

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

Verfügbare Optionen:
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,
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
required

O ID exclusivo da assinatura.

​
objectTypeId
string

O identificador do tipo de objeto associado à assinatura.

​
propertyName
string

O nome interno da propriedade que está sendo monitorada quanto a alterações. Somente se aplica quando "eventType" é "propertyChange".

​
updatedAt
string<date-time>

Quando esta assinatura foi atualizada pela última vez. Formatado como milissegundos a partir de era Unix.