WebhookWriteResult

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

Variante 1

CampoTipoPresençaDescrição
registeredbooleanobrigatório
idstringopcionalFormato: uuid
urlstringopcional
eventsarray<string>opcional
enabledbooleanopcional
excludeMessagesarray / nullopcional
hasSecretbooleanopcional
secretSealedbooleanopcional
createdAtstringopcionalRFC 3339. Formato: date-time
updatedAtstringopcionalRFC 3339. Formato: date-time
deliveryStatusobjectopcionalModelo: DeliveryStatus.
ignoredEventsarray<string>opcional
webhooksarray<object>opcional
inheritedGlobalbooleanopcionalIndica que a inscrição segue o webhook global do servidor.

Variante 2

CampoTipoPresençaDescrição
successbooleanobrigatórioValores: true
deletedbooleanobrigatórioValores: 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"
      ]
    }
  ]
}