← HomeFleetPay / API

List official B2B webhook event catalog

Parameters, data structure and responses from the versioned contract.

GET/webhooks/eventos
listarCatalogoEventosWebhookSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Returns all event types supported in outbound webhook subscriptions with reference payloads and HMAC-SHA256 signature headers (X-FleetPay-Signature, X-FleetPay-Event, X-FleetPay-Delivery). Requires operacao scope.

Authentication

Required Scope
operacao — Operations
Module
Webhooks & Subscriptions
Target Profiles
Shipper · Transport Manager · Dedicated Fleet Contractor · Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

No parameters declared for this operation.

Responses

200 HTTP Response

Operation processed successfully.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

Complete Operation Definition
{
  "tags": [
    "Webhooks"
  ],
  "operationId": "listarCatalogoEventosWebhook",
  "summary": "Listar catálogo oficial de eventos webhook B2B",
  "description": "Retorna todos os tipos de eventos suportados nas assinaturas webhook outbound com payload de referência e cabeçalhos de assinatura HMAC-SHA256 (`X-FleetPay-Signature`, `X-FleetPay-Event`, `X-FleetPay-Delivery`). Exige escopo `operacao`.",
  "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."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "webhooks",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/webhooks/eventos",
  "parameters": []
}