WebhookEventCatalogue

Every webhook event, who can have it, and what its data holds.

object

Fields

dataarray of objectrequired
ShowHide the fields of data
- typestringrequired
- descriptionstringrequired
- groupstringrequired
- versionintegerrequired
- kindsarray of enumrequired
  Which webhooks may subscribe to it.
  One ofpersonalstoreadmin
- scopesmap of stringrequired
  The scope an API key needs to subscribe a webhook to it, by kind.
- examplemap of anyrequired
  An example of its data.

Used by

GETWebhook events

WebhookEventCatalogue · example shape

{
  "data": [
    {
      "type": "string",
      "description": "string",
      "group": "string",
      "version": 0,
      "kinds": [
        "personal"
      ],
      "scopes": {
        "key": "string"
      },
      "example": {
        "key": null
      }
    }
  ]
}

From the schema: placeholder values, not real data.