Skip to main content

Custom APIs

Any app or API with public docs can post into a room's chat — including your own internal services and apps that are not in the gallery. You give the room agent the docs link; it reads the docs, builds the connector from them and sends a test. As with every chat app, nothing posts until a person presses Go live.

info

Custom APIs follow the same rules as other chat apps (see Connect an app), plus one company switch: Add any API or app in Company settings › Company chats must be on. When it is off, rooms connect only the apps in the gallery.

How to connect a custom API​

  1. Open Room settings › Chat and select the Custom API card, the first card in Add an app.
  2. In Connect any app or API, enter:
    • Docs or API link — the https address of the app's webhooks or events page, or the API address of a public feed.
    • Name (optional) — how it shows in the chat, for example Acme Status.
    • What should post here (optional) — for example New incidents, and when resolved.
    • How it delivers — Webhooks (it sends events the moment they happen), Public feed (Qik reads it on a schedule, no key needed) or Not sure (the agent decides from the docs).
  3. Select Build with the agent.

The room agent then works through the same two studio steps as any app — ① Sign in and ② Edit events — and you press Go live when the draft looks right.

How the agent builds it​

  • From the docs you gave it. The agent reads the app's public docs pages and builds only from them. Event names, signature headers and API addresses must all appear on the pages it read.
  • Sign-in the way the docs say. If the API uses a long-lived key or token, the studio shows a key box with the steps from the docs. If it uses OAuth, you register your company's own app with the provider and enter its client ID and secret; Qik shows the redirect address to use and renews the sign-in for you.
  • A picker, not questions. When the API has a list of projects or sources, the agent adds a picker so you choose from your own list.
  • A starter set of events, each checked with a sample message before you see it.

Reused across your company​

A custom connector is saved for your company. The next room that connects the same app starts from it, and each room still makes its own sign-in, picks its own sources and chooses its own events.