← InicioFleetPay / API

Registrar nueva suscripción webhook saliente

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

POST/webhooks/assinaturas
criarAssinaturaWebhookBase 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.

Registra una URL HTTPS pública, eventos suscritos y devuelve signing_secret una única vez al crearla. Rechaza URLs privadas/locales o HTTP en producción (anti-SSRF). 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.

Cuerpo de la Solicitud

Obligatorio

URL de destino y eventos suscritos.

application/json

urlstring · uriObligatorio
eventsarrayObligatorio
descriptionstring | nullOpcional

Respuestas

201 Respuesta HTTP

Suscripción webhook creada con secreto inicial.

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.

422 Respuesta HTTP

URL inválida/insegura o evento desconocido.

Definición Completa de la Operación
{
  "tags": [
    "Webhooks"
  ],
  "operationId": "criarAssinaturaWebhook",
  "summary": "Cadastrar nova assinatura webhook outbound",
  "description": "Registra URL HTTPS pública, eventos assinados e devolve `signing_secret` uma única vez na criação. Rechaza URLs privadas/locais ou HTTP em produção (anti-SSRF). Exige escopo `operacao`.",
  "requestBody": {
    "required": true,
    "description": "URL de destino e eventos assinados.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "url",
            "events"
          ],
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            },
            "events": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Assinatura webhook criada com segredo inicial.",
      "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."
    },
    "422": {
      "description": "URL inválida/insegura ou evento desconhecido."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "webhooks",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/webhooks/assinaturas",
  "parameters": []
}