Skip to main content

Checkly

The Checkly source connector lets you connect to the Checkly API using an API key.

Status​

This connector is currently in development:

  • Connection/login (credential validation) is implemented.
  • Catalog discovery is not yet implemented.
  • Data extraction/sync is not yet implemented.

If you configure this connector today, credential validation may succeed, but syncs will fail because extraction is not available yet.

Setup​

Prerequisites​

  • A Checkly account
  • A Checkly API key with access to the resources you want to sync

Create an API key in Checkly​

  1. In Checkly, create or locate an API key.
  2. Copy the key value (you’ll use it as the connector’s api_key).

Authentication​

This connector authenticates to Checkly using Bearer token authentication.

During credential validation, the connector calls:

  • GET https://api.checklyhq.com/v1/checks?limit=1

and includes your API key as a bearer token.

Configuration​

FieldTypeRequiredDescription
api_keystring✅Your Checkly API key used for Bearer authentication to the Checkly API.

Streams​

No streams are available yet. Catalog discovery currently returns an empty catalog, and extraction is not implemented.

Limitations​

  • Syncs are not supported yet (extraction is still in development).
  • Schema/cursor support is not available yet.