Openi DeveloperDeveloper
Referência da APIInbound hooks

OpenFinance inbound webhook

Receives OpenFinance webhook notifications. Requires `Authorization` header set to the tenant's stored secret. JSON body with `event` and `data` is expected.

POST
/hooks/of/{slug}

Path Parameters

slug*string

Header Parameters

Authorization*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

OpenFinance event payload. The connector consumes event, data.itemId, data.accountId, data.accountType, data.transactionIds, data.transactionsStartAt. Other fields are accepted but ignored.

event*string
data*
[key: string]?any

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/hooks/of/string" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{    "event": "string",    "data": {}  }'
{  "ok": true,  "skipped": true}

Inbound webhook — first sample capture

Public endpoint to receive the first JSON payload for a webhook data source. Requires `X-Webhook-Secret` header. Only `application/json` content is accepted. Captures the first sample within a 5-minute window after creation, activates the data source, and auto-creates a dataset.

Openi inbound webhook

Receives Openi event notifications. Requires `X-Webhook-Signature` header carrying the HMAC of the configured secret. The body shape is `{ event, companyId, data: { entityId? | entityIds[]? } }`. Recognized events: `INVOICE_CREATED`, `INVOICE_UPDATED`, `ACCOUNTING_ENTRY_CREATED`, `ACCOUNTING_ENTRY_UPDATED`. Unknown events return `200 { ok: true, skipped: true }`.