Configurer un abonnement au webhook (BÊTA)

Pour définir un ensemble d’abonnements webhook pour une application sur la nouvelle plateforme de développement, incluez un répertoire webhooks dans le projet ainsi qu’un fichier de configuration *-hsmeta.json.

Structure du répertoire

├──src
│   ├── app/
│   │   └── app-hsmeta.json
│   │   └── ...
│   │   └── webhooks/
│   │     └── webhooks-hsmeta.json
└──

Configuration du Webhook

Vous trouverez ci-dessous les options de configuration disponibles pour le fichier *-hsmeta.json.

{
  "uid": "webhooks",
  "type": "webhooks",
  "config": {
    "settings": {
      "targetUrl": "https://example.com/webhook",
      "maxConcurrentRequests": 10
    },
    "subscriptions": {
      "crmObjects": [
        {
          "subscriptionType": "object.creation",
          "objectType": "contact",
          "active": true
        }
      ],
      "legacyCrmObjects": [
        {
          "subscriptionType": "contact.propertyChange",
          "propertyName": "lastname",
          "active": true
        },
        {
          "subscriptionType": "contact.deletion",
          "active": true
        }
      ],
      "hubEvents": [
        {
          "subscriptionType": "contact.privacyDeletion",
          "active": true
        }
      ]
    }
  }
}

Les champs marqués par sont * obligatoires.

Champ	Type	Description
`uid`*	Chaîne	un identifiant unique interne pour le composant du webhook.
`type`*	Chaîne	le type de composant, qui devrait être `webhooks` dans ce cas.
`settings`*	Objet	un objet qui spécifie deux champs : `targetUrl`, qui est l’URL publique que HubSpot peut appeler l’endroit où les charges utiles de l’événement seront livrées, et `maxConcurrentRequests`, qui est le seuil supérieur des demandes HTTP que HubSpot effectuera dans une période donnée.
`subscriptions`*	Objet	un objet qui spécifie les types d’abonnements auxquels votre application s’abonnera.
`crmObjects`	Tableau	un tableau contenant des définitions d’abonnement aux événements. Il s’agit du tableau standard à inclure, qui doit être utilisé pour tous les événements dans le nouveau format (`object.*`). Les types d’abonnement de webhook classiques doivent plutôt être inclus dans les tableaux `legacyCrmObjects` et `hubEvents`, en fonction de l’événement.
`legacyCrmObjects`	Tableau	un tableau contenant les types d’abonnements classiques, tels que `contact.creation` et `deal.deletion`.
`hubEvents`	Tableau	un tableau contenant les types `contact.privacyDeletion` d’abonnements classiques et `conversation.*`

Pour chaque objet subscription, les champs suivants peuvent être spécifiés, en fonction du type de définition d’abonnement auquel vous êtes abonné (c’est-à-dire crmObjects, legacyCrmObjects ou hubEvents) ou selon que vous êtes abonné à une modification de propriété spécifique (par exemple, contact.propertyChange).

Champ	Type	Description
`subscriptionType`	Chaîne	le type d’événement auquel l’abonné est abonné.
`objectType`	Chaîne	pour les abonnements spécifiés dans le tableau `crmObjects`, cela spécifie l’objet CRM auquel votre application est abonnée.
`propertyName`	Chaîne	pour les abonnements de modification de propriété, cela spécifie la propriété qui déclenchera l’événement webhook.
`active`	Booléen	si des événements webhook seront déclenchés pour cet abonnement.

Créer des applications

Ajouter des fonctionnalités

Publier dans la Marketplace HubSpot

Configurer un abonnement au webhook (BÊTA)

Structure du répertoire

Configuration du Webhook

​Structure du répertoire

​Configuration du Webhook

Structure du répertoire

Configuration du Webhook