Getting started

Navigate to In the Integrations settings panel, click on the Generate key button if you don't already have an API key.

The generated API key is the required authentication token you must send in the Authorization header. Let's copy it.

You can use the /pings endpoint to check that you can successfully make an authenticated request. Do it directly from this documentation, using the Authorization input to paste your authentication token, then push the Try it! button.

Alternatively, you can run the following cURL command in a terminal:

curl -X 'POST' \
  '' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d ''

If you're successfully authenticated, you receive:

  "pong": "ok"

Otherwise you get a 401 - Unauthorized error. For example:

  "status": 401,
  "title": "Unauthorized",
  "message": "API token not found"