AsyncAPI channel · Fortnox
· Fortnox Topics WebSocket API
/topics-v1
The single WebSocket channel. The client publishes control commands
(currently `add-tenants-v1`) to subscribe tenants and set replay offsets,
and subscribes to the resulting change-notification events pushed by
Fortnox across all subscribed topics.
Send a control command to the WebSocket (e.g. add tenants).
subscribe
receiveTopicEvent
Receive pushed change-notification events.
Messages
AddTenantsCommand
Subscribe one or more tenants (integration keys) to the stream.
Content-Type: application/json
TopicEvent
A minimal "what changed" event on a domain topic.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
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.