Help Centre / Developer API & Webhooks
📘

Use the API schema endpoint

Each connection has a schema endpoint that returns allowed actions, events, samples, scopes, and security requirements.

Developer API & Webhooks4 min read

Where to call it

Use GET on the connection endpoint followed by /schema. Send the same Authorization Bearer token used for API actions.

What it returns

  1. Connection name, type, mode, endpoint, and schema URL.
  2. Security requirements such as secret, timestamp, and signature.
  3. Allowed scopes and actions for this connection.
  4. Outbound event list and copy-ready sample payloads.

When to use it

Use it when building custom apps, generating developer docs, or preparing n8n workflows without opening BOS settings repeatedly.

Need direct support?

Contact Kasaloma support if you cannot find the answer or your workspace needs checking.

Contact support