Central Fox Tecnologia LTDA Webhooks API
The webhooks API from Central Fox Tecnologia LTDA — 6 operation(s) for webhooks.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/foxnfe-com-br:foxnfe-com-br-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: FOX NF-e Webhooks API
version: '1.20260923'
description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: Webhooks
paths:
/api/v1/webhooks/config:
get:
operationId: get_api_v1_webhooks_config
tags:
- Webhooks
summary: WebhookConfig show
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:30
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
anyOf:
- type: object
properties:
configured:
type: boolean
example: false
- type: object
properties:
configured:
type: boolean
example: true
webhook_url:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:40
secret_preview:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:249
active:
type: boolean
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
configured: false
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:35
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:38
security:
- bearerAuth: []
put:
operationId: put_api_v1_webhooks_config
tags:
- Webhooks
summary: WebhookConfig update
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:46
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
webhook_url:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:73
secret_preview:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:249
active:
type: boolean
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
ok: true
webhook_url: null
secret_preview: null
active: false
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:71
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/put_api_v1_webhooks_configRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
webhook_url: https://example.invalid/callback
delete:
operationId: delete_api_v1_webhooks_config
tags:
- Webhooks
summary: WebhookConfig destroy
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:79
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
active:
type: boolean
example: false
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
ok: true
active: false
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:84
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:89
security:
- bearerAuth: []
/api/v1/webhooks/deliveries:
get:
operationId: get_api_v1_webhooks_deliveries
tags:
- Webhooks
summary: WebhookConfig deliveries
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:92
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:94
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: null
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:106
security:
- bearerAuth: []
/api/v1/webhooks/events:
get:
operationId: get_api_v1_webhooks_events
tags:
- Webhooks
summary: WebhookConfig events
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:205
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- throttle:60,1
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:208
type_prefix:
type: string
example: br.com.centralfox.foxnfe.
signature:
type: string
example: 'HMAC-SHA256 sobre o corpo canônico (chaves ordenadas), cabeçalho X-Webhook-Signature: sha256=<hex>'
delivery:
type: string
example: at-least-once; deduplicar pelo id do CloudEvent
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data: null
type_prefix: br.com.centralfox.foxnfe.
signature: 'HMAC-SHA256 sobre o corpo canônico (chaves ordenadas), cabeçalho X-Webhook-Signature: sha256=<hex>'
delivery: at-least-once; deduplicar pelo id do CloudEvent
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:207
security:
- bearerAuth: []
/api/v1/webhooks/test:
post:
operationId: post_api_v1_webhooks_test
tags:
- Webhooks
summary: WebhookConfig test
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:215
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- throttle:10,1
responses:
'202':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
event:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:227
delivery_id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:217
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
ok: true
event: null
delivery_id: null
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:225
security:
- bearerAuth: []
/api/v1/webhooks/deliveries/{delivery}/resend:
post:
operationId: post_api_v1_webhooks_deliveries__delivery__resend
tags:
- Webhooks
summary: WebhookConfig resend
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:117
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- throttle:10,1
responses:
'409':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: false
message:
type: string
example: Entrega já realizada com sucesso.
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
ok: false
message: Entrega já realizada com sucesso.
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:141
'422':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: false
message:
type: string
example: Entrega não está em estado terminal de falha.
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
ok: false
message: Entrega não está em estado terminal de falha.
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:148
'503':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: false
message:
type: string
example: Não foi possível confirmar o enfileiramento. Consulte o histórico antes de tentar novamente.
delivery_id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:193
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
ok: false
message: Não foi possível confirmar o enfileiramento. Consulte o histórico antes de tentar novamente.
delivery_id: null
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:190
'202':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
delivery_id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/WebhookConfigController.php:198
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
ok: true
delivery_id: null
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:198
security:
- bearerAuth: []
parameters:
- name: delivery
in: path
required: true
schema:
type: string
/api/v1/webhooks/billing/{gateway}:
post:
operationId: post_api_v1_webhooks_billing__gateway_
tags:
- Webhooks
summary: Webhook handle
x-source:
- app/routes/api.php:329-333
- app/app/Modules/Billing/Http/Controllers/WebhookController.php:20-66
- app/app/Modules/Billing/Http/Controllers/WebhookController.php:69-74
x-middleware:
- api
- throttle:60,1
responses:
'200':
description: Evento verificado e processado.
content:
text/plain:
schema:
type: string
example: OK
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: OK
'400':
description: Gateway desconhecido.
content:
text/plain:
schema:
type: string
example: Unknown gateway
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: Unknown gateway
'401':
description: Assinatura ausente ou inválida.
content:
text/plain:
schema:
type: string
example: Signature invalid
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: Signature invalid
'429':
description: Limite de requisições excedido.
'500':
description: Falha interna ao processar o evento já verificado.
content:
text/plain:
schema:
type: string
example: Internal error
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: Internal error
parameters:
- name: gateway
in: path
required: true
schema:
type: string
enum:
- stripe
description: 'Gateway de cobrança. Valor implementado: stripe.'
- name: Stripe-Signature
in: header
required: true
schema:
type: string
description: Assinatura Stripe do corpo bruto.
description: Recebe webhook público de cobrança. A assinatura é verificada antes de qualquer persistência. O único gateway aceito atualmente é Stripe.
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
description: Evento bruto do gateway; o formato varia conforme o tipo de evento Stripe.
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: {}
components:
schemas:
put_api_v1_webhooks_configRequest:
type: object
properties:
webhook_url:
x-laravel-rules:
- required
- url
- max:2048
type: string
format: uri
maxLength: 2048
webhook_secret:
x-laravel-rules:
- sometimes
- string
- min:16
- max:255
type: string
minLength: 16
maxLength: 255
required:
- webhook_url
x-source:
- app/app/Http/Controllers/Api/V1/WebhookConfigController.php:48
securitySchemes:
bearerAuth:
type: http
scheme: bearer