# Webhook

Estrutura de dados do contrato OpenAPI.

## Campos

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `registered` | `boolean` | obrigatório | — |
| `id` | `string` | opcional | Formato: `uuid` |
| `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` |
| `deliveryStatus` | `object` | opcional |  Modelo: [DeliveryStatus](https://wpp.atendro.cloud/docs/modelos/delivery-status.md). |
| `ignoredEvents` | `array<string>` | opcional | — |
| `webhooks` | `array<object>` | opcional | — |
| `inheritedGlobal` | `boolean` | opcional | Indica que a inscrição segue o webhook global do servidor. |

## Definição OpenAPI

```json
{
  "type": "object",
  "properties": {
    "registered": {
      "type": "boolean"
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "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"
    },
    "deliveryStatus": {
      "$ref": "#/components/schemas/DeliveryStatus"
    },
    "ignoredEvents": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "webhooks": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "inheritedGlobal": {
      "type": "boolean",
      "description": "Indica que a inscrição segue o webhook global do servidor."
    }
  },
  "required": [
    "registered"
  ]
}
```