Skip to main content

​
Overview

An application is a container for the API keys your integration uses to talk to the Custral API. You create an application, then mint one or more keys under it, so you can rotate or revoke a single key without disturbing the others. Manage them at Settings → Applications.

​
Create an application

1

Open Applications

Go to Settings → Applications and click Create Application.
2

Name it

Give it a name you’ll recognize later: “Production backend”, “Zapier”, etc. Each application shows a status and a created date.
3

Open the application

Click the application row to open its detail page, where its keys live.

​
Mint an API key

From an application’s detail page, choose Add New API Key:
  • Key name: a label for this key (e.g. “Development key”).
  • Key type:
    • Publishable (Frontend): safe to use in client-side code (for example, the browser widget).
    • Secret (Backend): server-side access; never expose it in a browser or commit it to source control.
A key’s scopes determine which routes it can call. See Authentication & scopes.
A secret key grants server-side access to your workspace. Store it in a secret manager, never in client code or version control. If one leaks, revoke it here and mint a replacement.

​
Rotate & revoke

Because keys live under an application, you can mint a replacement, move traffic to it, then revoke the old one, with zero downtime for your other keys.

​
Troubleshooting