← InicioFleetPay / API

Listar suscripciones webhook activas de la company

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/webhooks/assinaturas
listarAssinaturasWebhookBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Lista todas las suscripciones webhook registradas por la company autenticada sin exponer el secreto de firma en texto claro. Exige alcance operacao.

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Webhooks y Suscripciones
Perfiles Aplicables
Embarcador · Gestor de Transporte · Agregado Empresarial · Transportista Flotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Respuestas

200 Respuesta HTTP

Operación procesada con éxito.

application/json

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

Credencial ausente, inválida o de otro entorno.

403 Respuesta HTTP

Permiso del panel no habilitado o recurso fuera del alcance de la company.

Definición Completa de la Operación
{
  "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": []
}