← InícioFleetPay / API

Revogar assinatura webhook outbound

Parâmetros, estrutura de dados e respostas do contrato versionado.

DELETE/webhooks/assinaturas/{uuid}
revogarAssinaturaWebhookBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Desativa e remove uma assinatura webhook existente da company autenticada. Exige escopo operacao.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Webhooks e Assinaturas
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Agregado Empresarial · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

uuidpath · stringObrigatório

UUID da assinatura webhook.

Restrições
{
  "type": "string"
}

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

404 Resposta HTTP

Assinatura não encontrada.

Definição Completa da Operação
{
  "tags": [
    "Webhooks"
  ],
  "operationId": "revogarAssinaturaWebhook",
  "summary": "Revogar assinatura webhook outbound",
  "description": "Desativa e remove uma assinatura webhook existente da company autenticada. Exige escopo `operacao`.",
  "parameters": [
    {
      "name": "uuid",
      "in": "path",
      "required": true,
      "description": "UUID da assinatura webhook.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Operação processada com sucesso.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "404": {
      "description": "Assinatura não encontrada."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "webhooks",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "DELETE",
  "path": "/webhooks/assinaturas/{uuid}"
}