Use the API and webhooks

The API lets your own code do what a teammate does in the inbox: post ideas for customers, move them between statuses, reply, vote on someone's behalf, and keep people and companies in step with your product. Webhooks go the other way and tell your server when something happens on the board.

Make a key

1. Open Settings›API, type a name under New key name for the tool that will use it, for example “CRM sync”, and click Create key.
2. Copy the key straight away. It is shown once; Kjerr keeps only a fingerprint of it.
3. Put it in your server's secrets and send it with every call. The endpoints and examples are in the API reference.

• Tick Read only for tools that only report, such as a data warehouse. Such a key can list and read, and cannot change anything.
• A key acts as the teammate who made it. A status change it makes emails voters in that teammate's name, just as the inbox would, and the key stops working if they leave the team.
• Make one key per tool. Revoke beside a key stops it at once without touching the others.

Add a webhook

1. Under Webhooks, paste the https:// address of your endpoint and click Add webhook.
2. Untick the events you do not need and click Save. Every event is on at first.
3. Click Send test and reload after a few seconds. Recent deliveries shows whether your endpoint answered.

A delivery that fails is tried again over about 18 hours. Untick On to pause a webhook without deleting it.

Check that a delivery came from Kjerr

Every delivery is signed with the Signing secret shown under the webhooks, in the Standard Webhooks format, so your developer can check it with one of its libraries. Rotate secret makes a new one and keeps the old one signing for 24 hours while your server is updated. Revoke now stops the old one at once, for a secret that leaked.