WebhookWriteResult
Estrutura de dados do contrato OpenAPI.
Estrutura de dados do contrato OpenAPI.
Campos
Variante 1
| 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. |
ignoredEvents | array<string> | opcional | — |
webhooks | array<object> | opcional | — |
inheritedGlobal | boolean | opcional | Indica que a inscrição segue o webhook global do servidor. |
Variante 2
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
success | boolean | obrigatório | Valores: true |
deleted | boolean | obrigatório | Valores: true |
Definição OpenAPI
json
{
"oneOf": [
{
"$ref": "#/components/schemas/Webhook"
},
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"deleted": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"success",
"deleted"
]
}
]
}