Leer una suscripción a eventos

Recupera una suscripción a eventos específica por ID.

GET /webhooks/v3/{appId}/subscriptions/{subscriptionId}

Leer una suscripción a eventos

cURL

curl --request GET \
  --url 'https://api.hubapi.com/webhooks/v3/{appId}/subscriptions/{subscriptionId}?hapikey='

200

{
  "active": true,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "eventType": "contact.propertyChange",
  "id": "12",
  "propertyName": "email",
  "updatedAt": "2019-11-30T03:30:17.883Z"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.

Marketing HubPro

Sales HubPro

Service HubPro

Content HubStarter

Autorizaciones

hapikey · string · query · requerido

Parámetros de ruta

appId · integer<int32> · requerido

El ID de la aplicación de destino.

subscriptionId · integer<int32> · requerido

El ID de la suscripción de destino.

Respuesta

200

application/json

successful operation

Complete details for an event subscription.

active · boolean · requerido

Si la suscripción está activa o en pausa. Si es verdadero, la suscripción enviará notificaciones de webhook. Si es falso, la suscripción está en pausa y no enviará notificaciones.

createdAt · string<date-time> · requerido

La marca de tiempo en que se creó la suscripción al webhook, en formato ISO 8601 (por ejemplo, 2020-02-29T12:30:00Z).

eventType · enum<string> · requerido

El tipo de evento que quieres detectar. Los valores aceptados son contact.creation, contact.deletion, contact.propertyChange y tipos de eventos similares para otros objetos del CRM y objetos personalizados.

Opciones disponibles: 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 · requerido

El ID único de la suscripción al webhook.

eventTypeName · string

El nombre del evento que se detectará. Se usa con objetos personalizados para especificar tipos de eventos personalizados de comportamiento más allá de los valores estándar de la enumeración eventType.

objectTypeId · string

El ID del tipo de objeto para la suscripción. Puede ser un objeto estándar del CRM (por ejemplo, "contacto", "empresa", "negocio") o un ID de objeto personalizado para suscripciones de objetos personalizados.

propertyName · string

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

updatedAt · string<date-time>

La marca de tiempo de la última actualización de la suscripción al webhook, en formato ISO 8601 (por ejemplo, 2020-02-29T12:30:00Z).