Skip to main content

Connect an app

The room agent builds every chat app connection. It signs in with you, sets up the webhook or hourly sync, chooses a starter set of events and checks the messages render. The app stays a draft until a person presses Go live in the connector studio, so nothing posts into the chat until you have seen exactly what it will post.

Before you start

To connect an app you need all of these:

  • a company role of owner, admin or creator,
  • the owner or host role in the room,
  • the agent switched on for your company, with agent credits for the agent's run,
  • Chat apps switched on in Company settings › Company chats, and room on your plan for another app (see Plans and limits).

How to start a connection​

  1. Open the room and select ⋯ › Room settings › Chat.
  2. Under Add an app, search for the app or browse a category. Each app shows its usual delivery (webhook or hourly) and the events it can post.
  3. Select the app. The room agent starts at once with Connect <App> to this chat.

You can also ask in the agent bar in your own words — for example "Connect GitHub to this chat" or "Post Sentry alerts here". To connect an app that is not in the gallery, select the Custom API card, the first card in the gallery — see Custom APIs.

tip

The gallery marks apps that are already set up: In this chat, Draft here, or connected in other rooms of your company. Opening the chat header's app marks also shows Add an app.

Step ① Sign in​

The agent's run card shows the sign-in for the app.

  1. Follow the steps on the card. Depending on the app, select Continue with <App> and allow access in the app's own consent screen, or create a key in the app and paste it into the key box. The card says why Qik needs access, which permission to give, and which addresses the key will be sent to.
  2. Select Test and continue. The key is saved in Qik's vault for this room.
  3. Pick the projects first — choose the repositories, projects or sources to follow from your own list in the app. The list is searchable, and you can pick more than one when the app allows it. The agent never asks you to type names in chat.
  4. The webhook is added. When Qik can add it for you, it does (Qik added the webhook in <App>). When the app needs it added by hand, the studio shows the webhook address and secret, each with a copy button, plus Open the webhooks page and the steps to follow. Apps without webhooks are read every hour instead.

The agent then turns on a starter set of events, checks that each message renders, and tells you the app is a draft until you press Go live.

Step ② Edit events​

Select Open in studio on the run card, or Open studio beside the app under Draft apps in Room settings › Chat. The studio's step dots show what is left.

  1. Review the events the agent picked. Switch any event on or off, add filters, and change how the message reads — see Edit events and messages.
  2. Select Send a test to post a real sample card into the chat.
  3. Select Go live.

What happens at Go live​

  • The app starts posting the events you switched on.
  • A welcome card tells the room what the app posts, from where, and who set it up. It has an Edit events button for owners and hosts.
  • The app moves from Draft apps to Connected apps, and its mark appears in the chat header.

Only a person makes an app live. The agent prepares the draft and never presses Go live itself, and after Go live the agent cannot switch events on or off — that stays with the room's owners and hosts.

Drafts​

A draft keeps everything you have set up. It posts nothing except the tests you send, but it still records the events it receives, so the studio's preview and Last week counts show what it would post. Drafts show faded with an amber dot in the chat header, and under Draft apps with their step dots.

Disconnect, connect again or delete​

Open the app from Connected apps (or Edit events on any of its messages):

  • Disconnect stops posting and keeps everything — events, messages, people and the sign-in. The app shows Disconnected.
  • Connect starts posting again.
  • Delete app (in the ⋯ menu) removes the app from this chat, along with the webhook Qik added in the app.