← HomeFleetPay / API

List active webhook subscriptions for the company

Parameters, data structure and responses from the versioned contract.

GET/webhooks/assinaturas
listarAssinaturasWebhookSandbox Base: https://api.fleetpay.site/v1

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

Lists all webhook subscriptions registered by the authenticated company without exposing the signing secret in plaintext. 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": "listarAssinaturasWebhook",
  "summary": "Listar assinaturas webhook ativas da company",
  "description": "Lista todas as assinaturas webhook cadastradas pela company autenticada sem expor o segredo de assinatura em texto claro. 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/assinaturas",
  "parameters": []
}