Skip to content

Emit an event to an application (fan-out)

POST
/v1/app/{app_id}/event

Fan one event out to every endpoint the application has subscribed to the event type. The application may be auto-created on first send.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters

Header Parameters

Idempotency-Key

POST only. Duplicate requests with the same key within ~12–24 h return the original response and create no second effect.

Type
string
Format
"uuid"

Path Parameters

app_id*

The application id, or your own end-customer id (uid).

Type
string
Required

Request Body

application/json
JSON
{
  
"event_type": "invoice.created",
  
"payload": {
  
}
}

Responses

Accepted — fanned out to matching endpoints.

application/json
JSON
{
  
"message_id": "msg_01JX9",
  
"fanout": 3
}

Playground

Authorization
Headers
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

Apache-2.0 licensed · a Finnoto product