Create an API key and make your first request

Before you start

You need access to Settings / API Keys and the permissions required by your integration.

Connect your integration

1. 01

   Open API Keys

   Open Settings, then API Keys in the admin dashboard.

2. 02

   Create a scoped key

   Name the key for your integration and select only the scopes it needs. Save the secret when it is shown; it is displayed once.

3. 03

   Authenticate a request

   Send X-API-Key: YOUR_API_KEY to the events endpoint, or use Authorization: ApiKey YOUR_API_KEY. Check the API reference for the endpoint’s fields and responses.

Keep your keys up to date

Store secrets in a secret manager or environment variable. To rotate a key, create a replacement, update your integration, then revoke the old key. Revoke a key if it is exposed or no longer used.

The API reference lists endpoint fields, required scopes and response details. Review the endpoint you need before sending production data.