GlobalWebhook

Estrutura de dados do contrato OpenAPI.

Campos

Campo	Tipo	Presença	Descrição
`registered`	`boolean`	obrigatório	—
`url`	`string`	opcional	—
`events`	`array<string>`	opcional	—
`enabled`	`boolean`	opcional	—
`excludeMessages`	`array / null`	opcional	—
`hasSecret`	`boolean`	opcional	—
`secretSealed`	`boolean`	opcional	—
`createdAt`	`string`	opcional	RFC 3339. Formato: `date-time`
`updatedAt`	`string`	opcional	RFC 3339. Formato: `date-time`
`ignoredEvents`	`array<string>`	opcional	—
`scope`	`string`	obrigatório	Valor fixo: `"server"`

Definição OpenAPI

json

{
  "type": "object",
  "properties": {
    "registered": {
      "type": "boolean"
    },
    "url": {
      "type": "string"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "enabled": {
      "type": "boolean"
    },
    "excludeMessages": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "hasSecret": {
      "type": "boolean"
    },
    "secretSealed": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "description": "RFC 3339.",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "description": "RFC 3339.",
      "format": "date-time"
    },
    "ignoredEvents": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "scope": {
      "type": "string",
      "const": "server"
    }
  },
  "required": [
    "registered",
    "scope"
  ]
}