urlstring · uriObrigatório← InícioFleetPay / API
Cadastrar nova assinatura webhook outbound
Parâmetros, estrutura de dados e respostas do contrato versionado.
POST
/webhooks/assinaturasDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
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.
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
Nenhum parâmetro declarado nesta operação.
Corpo da Requisição
Obrigatório
URL de destino e eventos assinados.
application/json
eventsarrayObrigatóriodescriptionstring | nullOpcionalRespostas
201 Resposta HTTP
Assinatura webhook criada com segredo inicial.
application/json
data—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"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.
422 Resposta HTTP
URL inválida/insegura ou evento desconhecido.
Definição Completa da Operação
{
"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": []
}