Openi DeveloperDeveloper
Referência da APIInbound hooks

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 }`.

POST
/hooks/openi/{slug}

Path Parameters

slug*string

Header Parameters

X-Webhook-Signature*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

event*string

Value in

  • "INVOICE_CREATED"
  • "INVOICE_UPDATED"
  • "ACCOUNTING_ENTRY_CREATED"
  • "ACCOUNTING_ENTRY_UPDATED"
companyId*string
data?
[key: string]?any

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/hooks/openi/string" \  -H "X-Webhook-Signature: string" \  -H "Content-Type: application/json" \  -d '{    "event": "INVOICE_CREATED",    "companyId": "string"  }'
{  "ok": true,  "jobsEnqueued": 0}

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.

Export matches as CSV

Streams a CSV with header match.id,decision,left.dataset,right.dataset plus the requested left/right fields. At least one of leftFields or rightFields must be provided.