Skip to main content

Authorization

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

Canny

Prerequisites​

Before creating a Canny credential in Nexla, you need to obtain your secret API key from your Canny workspace. This key authenticates Nexla with the Canny API and grants access to your workspace data, so it should be kept secure.

Obtain a Canny API Key​

Canny provides a single secret API key per workspace that is used to authenticate all API requests. Generating or retrieving this key requires admin access to the Canny workspace.

  1. Sign in to your Canny account at canny.io as an admin user.

  2. Open your workspace settings by clicking your workspace name, then navigate to Settings > API.

  3. Locate your secret API key in the API section. This key is unique to your workspace and is used to authenticate every API request.

    Your Canny API key is secret and provides full access to your workspace data through the API. Store it securely, do not share it publicly, and do not commit it to version control systems. For complete details about Canny API authentication, see the Canny API reference.

Nexla sends this key in the x-api-key request header when authenticating with the Canny API. Additional information about obtaining and using the API key is available in The Canny API help article.

Create a Canny Credential​

  • To create a new Canny 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 Configuration​

  1. Enter your Canny API key in the API Key field. This key authenticates Nexla with the Canny API and should match the secret key obtained from your Canny workspace settings. Nexla sends this value in the x-api-key header for all API requests to Canny.

    The API key provides full access to your Canny workspace data through the API. Keep your API key secure and do not share it publicly. If you suspect your key has been compromised, regenerate it in your Canny workspace API settings.

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.