Passer au contenu principal
PATCH
/
webhooks
/
v3
/
{appId}
/
subscriptions
/
{subscriptionId}
Mettre à jour un abonnement à un événement
curl --request PATCH \
  --url https://api.hubapi.com/webhooks/v3/{appId}/subscriptions/{subscriptionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true
}'
{
  "active": true,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "eventType": "contact.propertyChange",
  "id": "12",
  "propertyName": "email",
  "updatedAt": "2019-11-30T03:30:17.883Z"
}

Supported products

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

appId
integer<int32>
requis

L'ID de l'application cible.

subscriptionId
integer<int32>
requis

L'ID de l'abonnement à mettre à jour.

Corps

application/json

Updated details for the subscription.

Updated details for the subscription.

active
boolean

Permet d'activer ou de suspendre l'abonnement aux webhooks. Si la valeur est « true », l'abonnement enverra des notifications de webhook. Si la valeur est « false », l'abonnement sera suspendu et n'enverra pas de notifications.

Réponse

successful operation

Complete details for an event subscription.

active
boolean
requis

Indique si l'abonnement est actif ou suspendu. Si la valeur est « true », l'abonnement enverra des notifications de webhook. Si la valeur est « false », l'abonnement sera suspendu et n'enverra pas de notifications.

createdAt
string<date-time>
requis

L'horodatage de la création de l'abonnement au webhook, au format ISO 8601 (par exemple, 2020-02-29T12:30:00Z).

eventType
enum<string>
requis

Le type d'évènement à écouter. Les valeurs acceptées incluent contact.creation, contact.deletion, contact.propertyChange et des types d'évènements similaires pour d'autres objets CRM et objets personnalisés.

Options 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
requis

L'ID unique de l'abonnement au webhook.

eventTypeName
string

Le nom de l'évènement à écouter. Il est utilisé avec des objets personnalisés pour spécifier des types d'évènements personnalisés au-delà des valeurs d'énumération eventType standard.

objectTypeId
string

L'ID du type d'objet pour l'abonnement. Il peut s'agir d'un objet CRM standard (par exemple, « contact », « entreprise », « transaction ») ou d'un ID d'objet personnalisé pour les abonnements à des objets personnalisés.

propertyName
string

Le nom interne de la propriété à surveiller pour les changements. S'applique uniquement lorsque eventType est propertyChange.

updatedAt
string<date-time>

L'horodatage de la dernière mise à jour de l'abonnement au webhook, au format ISO 8601 (par exemple, 2020-02-29T12:30:00Z).

Last modified on April 13, 2026