Saltar para o conteúdo

Webhooks e auditoria – construir no Flowtly

Utilize este instantâneo selecionado do esquema OpenAPI do Flowtly para planear integrações, automatizar fluxos de trabalho e sincronizar os dados em que as suas equipas confiam.

Estado da documentação

Última sincronização em 2026-04-03 18:31 (versão da aplicação 2.0.0)

Apenas um subconjunto de entidades é tornado público. Execute ambos os comandos de sincronização para atualizar esta documentação quando a aplicação Flowtly disponibilizar novas capacidades.

Webhooks e auditoria

Subscrições de eventos, registos de webhook e trilho de auditoria.

Visão geral da entidade

Webhook

Registar endpoints de webhook para receber notificações quando os dados do Flowtly mudam, com registos de entrega para diagnóstico.

Endpoints

GET https://api.flowtly.eu/webhooks

Listar webhooks

Obtém a coleção de recursos WebhookLog.

POST https://api.flowtly.eu/webhooks

Criar webhook

Cria um recurso Webhook.

POST https://api.flowtly.eu/webhooks/e_invoice/incoming_cost

Criar incoming_cost

Webhook de fatura de custo recebida

POST https://api.flowtly.eu/webhooks/e_invoice/status

Criar estado

Cria um recurso Webhook.

POST https://api.flowtly.eu/webhooks/stripe

Criar stripe

Cria um recurso Webhook.

GET https://api.flowtly.eu/webhooks/{id}

Obter webhook por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/webhooks/{id}

Eliminar webhook

Eliminar o recurso.

PATCH https://api.flowtly.eu/webhooks/{id}

Atualizar webhook

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/webhook-logs

Listar webhooks

Obtém a coleção de recursos WebhookLog.

GET https://api.flowtly.eu/webhook-logs/{id}

Obter webhook por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Subscrever alterações de estado de faturas para acionar lembretes de pagamento.
Monitorizar registos de entrega de webhooks para diagnosticar falhas de integração.

Campos do esquema

WebhookLog-webhook_log.read
Campo Tipo Descrição
id string Campo id.
url string Campo url.
event string Campo event.
statusCode integer | null Campo statusCode.
responseTime integer Campo responseTime.
response string Campo response.

Visão geral da entidade

Registo de auditoria

Consultar o trilho de auditoria para acompanhar quem alterou o quê e quando, para monitorização de conformidade e segurança.

Endpoints

GET https://api.flowtly.eu/audit-logs

Listar registos de auditoria

Obtém a coleção de recursos AuditLog.

GET https://api.flowtly.eu/audit-logs/{id}

Obter registo de auditoria por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Enviar eventos de auditoria para o seu SIEM para monitorização de segurança.
Gerar relatórios de conformidade que mostram padrões de acesso a dados.

Campos do esquema

AuditLog-audit_log.read_employee.preview
Campo Tipo Descrição
id string Campo id.
action string Campo action.
executorEmployee object Campo executorEmployee.
relatedEmployee object Campo relatedEmployee.
relationId string Campo relationId.
relationName string Campo relationName.
metadata array Campo metadata.
createdAt string Campo createdAt.
Whatsapp