Skip to main content
POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
Crear una suscripción a eventos
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": "2023-11-07T05:31:56Z",
  "eventType": "company.associationChange",
  "id": "<string>",
  "objectTypeId": "<string>",
  "propertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubPro
Sales HubSales HubPro
Service HubService HubPro
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer<int32>
required

El ID de la aplicación.

Body

application/json

New webhook settings for an app.

​
eventType
enum<string>
required

Tipo de evento a escuchar. Puede ser create, delete, deletedForPrivacy o propertyChange.

Available options:
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 si la suscripción está activa o pausada. Por opción predeterminada, es false.

​
objectTypeId
string
​
propertyName
string

El nombre interno de la propiedad que se monitoreará en busca de cambios. Solo se aplica cuando "eventType" es "propertyChange".

Response

successful operation

Complete details for an event subscription.

​
active
boolean
required

Determina si la suscripción está activa o pausada.

​
createdAt
string<date-time>
required

Cuando se creó esta suscripción. Formateado como milisegundos desde la época Unix.

​
eventType
enum<string>
required

Tipo de evento a escuchar. Puede ser "create", "delete', "deletedForPrivacy" o "propertyChange".

Available options:
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

El ID único de la suscripción.

​
objectTypeId
string

El identificador del tipo de objeto asociado con la suscripción.

​
propertyName
string

El nombre interno de la propiedad que se monitoreará en busca de cambios. Solo se aplica cuando "eventType" es "propertyChange".

​
updatedAt
string<date-time>

Cuando se actualizó por última vez esta suscripción. Formateado como milisegundos desde la Unix epoch.