Skip to main content

Authorization

Follow this guide to create a new Clockify credential that will allow Nexla to authenticate to and exchange data with your Clockify account.
clockify_api_auth.png

Clockify

Prerequisites​

Before creating a Clockify credential in Nexla, ensure that you have an active Clockify account and have generated an API key. Clockify authenticates API requests using an API key passed in the X-Api-Key request header, so this key is the only credential required to connect Nexla to your Clockify workspace.

Generate a Clockify API Key​

The Clockify API key is generated from your personal profile settings and grants access to all workspaces that your Clockify user account can access.

  1. Sign in to your Clockify account at app.clockify.me.

  2. Click your profile picture or initials in the lower-left corner of the navigation menu, and select Profile settings.

  3. Scroll down to the API section near the bottom of the Profile settings page.

  4. Click the Generate button to create a new API key.

  5. Copy the generated API key and store it in a secure location.

    Important

    Copy the API key immediately after it is generated. Once you close or navigate away from the page, the full key value is no longer displayed and you will need to generate a new key.

If your organization uses a dedicated Clockify subdomain (for example, https://{subdomain}.clockify.me), you must generate the API key from the Profile settings page within that subdomain. A key generated on the standard app domain will not authenticate against a subdomain workspace.

The Clockify REST API enforces a rate limit of 10 requests per second per API key, and workspaces on the Free plan are additionally limited to 30 requests per hour. For complete authentication details, refer to the official Clockify API documentation.

Create a Clockify Credential​

  • To create a new Clockify credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

Clockify uses API key authentication. The API key you generated in your Clockify profile settings is sent by Nexla in the X-Api-Key header of every request to authenticate with the Clockify API.

  1. Enter the API key generated in your Clockify profile settings in the API Key Value field. This value authenticates Nexla with the Clockify API and should be kept secure, as it grants access to all workspaces available to your Clockify user account.

    Nexla stores the API key as a secured, encrypted value. When this credential is used, Nexla automatically attaches the key to the X-Api-Key request header, so no additional header configuration is required.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.