Install an app and turn it off

When you need it

The team needs a button or a short panel on the board, and you do not have to write an extension.

Before you start

• You are an organisation administrator.
• The board belongs to that organisation: the panel shows the apps of its organisation.

Steps

1. Install the app:

curl -X POST https://boards.example.com/api/orgs/$ORG/apps \
  -H "Content-Type: application/json" --cookie "$SESSION" \
  -d '{"appId":"app.hello"}'

2. Open the board and press Приложения in the top bar.
3. Result: the panel contains the app and its button.

Checking the action

1. Press Поздороваться.
2. Result: the panel shows "Hello, {your name}!".
3. The organisation audit gets app.invoked, and the event queue gets an app.invoked event.

Turning it off

1. Turn the app off:

curl -X PATCH https://boards.example.com/api/orgs/$ORG/apps/app.hello \
  -H "Content-Type: application/json" --cookie "$SESSION" \
  -d '{"enabled":false}'

2. Refresh the panel.
3. Result: the app is not in the panel, and its action returns 404. Turning it back on restores everything.

Common mistakes

Where to go next

Apps — what the panel draws and what it does not do.