Developer access is where you issue the API keys and register the webhook endpoints that connect this workspace to other systems. A key may call only the routes you choose for it, and its secret is shown once.
Who can do this
An owner or editor of the workspace. Issuing a key also needs a recent identity check, so you may be asked to confirm it is you.
Find it
Open Settings and choose Developers. The page is Developer access. It shows the address of this deployment's API at the top.
Issue an API key
- Press Issue a key. The form has steps. Press Continue to move on.
- Name the key: give the Key name and, if you like, an expiry date.
- Choose permitted routes: tick the routes the key may call.
- Review and issue: check the name, expiry and permitted routes, and press Issue API key.
- Under Copy this key now, press Copy key. The secret is not shown again.
The key is listed under API keys as Active, with its scope and when it was created, last used and expires.
Revoke a key
Press Revoke beside the key, give the Reason for revocation and press Confirm revoke. The key is then listed as Revoked.
Add a webhook
- Under Add a webhook, give the Endpoint URL. It must be HTTPS.
- Under Events, list the exact events it should receive, separated by commas.
- Press Add webhook.
The endpoint is listed under Webhooks as Delivering, with its events.
Disable a webhook
Press Disable beside the endpoint, give the Reason for disabling and press Confirm disable. It is then listed as Disabled.
Common questions
"Can I see a key's secret again?" No. It is shown once. If it is lost, revoke the key and issue a new one.
"Can a key call any route?" No. Only the routes chosen when it was issued.