Skip to main content
Every Clapvo API request must be authenticated with a personal access token, passed in the x-api-key header. You generate and manage these tokens from the Developer section of Clapvo.

Generate an API token

Personal access tokens function like ordinary access tokens — they authenticate your scripts and integrations to the Clapvo API.
1

Open the Developer section

In the left sidebar, under Manage, click Developer, then open the API Tokens tab. If you haven’t created one yet, you’ll see an empty state.
Empty API Tokens tab in the Developer section
2

Click Generate new token

Select Generate new token in the top right to open the Create API Token form.
3

Name the token

Enter an API Key Name that describes where the token will be used (for example, Order notifications or CRM integration). This helps you identify the token later.
4

Set an expiration

Choose an Expiration for the token. Pick a shorter window for temporary use, or a longer one for a permanent integration.
5

Select the events

Under Events, choose what this token is allowed to do. For sending messages, check Messaging → Send Message. A token can only trigger the events you select here.
Create API Token form with the Send Message event selected
6

Generate the key

Click Generate API Key. The new token appears in your API Tokens list.

Copy and store your token

In the API Tokens list, each token is masked by default. Use the eye icon to reveal it and the copy icon to copy it to your clipboard.
API Tokens list showing a generated token
Treat your token like a password. Copy it as soon as it’s created and store it somewhere secure. Never expose it in client-side code, public repositories, or shared links. If a token is leaked, delete it from the list and generate a new one.

Use the token in a request

Pass the token in the x-api-key header on every request:
Requests sent without a valid token, or with a token that lacks the required event, are rejected.

Next steps