Zum Hauptinhalt springen
Última modificação: 8 de outubro de 2025
Para definir uma assinatura de webhook para um aplicativo na nova plataforma para desenvolvedores, inclua um diretório webhooks no projeto, juntamente com um arquivo de configuração *-hsmeta.json.

​
Estrutura do diretório

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

​
Configuração do webhook

Veja as opções de configuração disponíveis para o arquivo *-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
        }
      ]
    }
  }
}

Campos marcados com * são obrigatórios.

CampoTipoDescrição
uid*StringUm identificador exclusivo interno do componente de webhook.
type*StringO tipo de componente, que deve ser webhooks neste caso.
settings*ObjetoUm objeto que especifica dois campos: targetUrl, que é o URL disponível publicamente para que o HubSpot chame onde as cargas do evento serão entregues, e maxConcurrentRequests, que é o limite superior das solicitações HTTP que o HubSpot fará em um determinado intervalo de tempo.
subscriptions*ObjetoUm objeto que especifica os tipos de assinatura em que seu aplicativo se inscreverá.
crmObjectsMatriz

Uma matriz que contém definições de assinatura de evento. Essa é a matriz padrão a ser incluída e deve ser usada para todos os eventos no novo formato (object.*).

Os tipos de assinatura de webhook clássico devem ser incluídos nas matrizes legacyCrmObjects e hubEvents, dependendo do evento.

legacyCrmObjectsMatrizUma matriz que contém tipos de assinatura clássicos, como contact.creation e deal.deletion.
hubEventsMatrizUma matriz que contém os tipos de assinatura clássica contact.privacyDeletion e conversation.*
Para cada objeto subscription, os seguintes campos podem ser especificados, com base no tipo de definição de assinatura em que você está inscrito (ou seja, crmObjects, legacyCrmObjects, ou hubEvents) ou se você está se inscrevendo em uma mudança de propriedade específica (por exemplo, contact.propertyChange).
CampoTipoDescrição
subscriptionTypeStringO tipo de evento que está sendo assinado.
objectTypeStringPara assinaturas especificadas dentro da matriz crmObjects, especifica o objeto do CRM que seu aplicativo está assinando.
propertyNameStringPara assinaturas de alteração de propriedade, especifica quais propriedades acionarão o evento de webhook.
activeBooleanoSe os eventos de webhook serão disparados para esta assinatura.