Skip to main content

Authorization

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

Gist

Prerequisites​

To connect Nexla to your Gist account, you need a Gist API key. The API key is available from your Gist workspace settings and authenticates all API requests made on behalf of your account.

Obtain Your Gist API Key​

Gist uses API key-based authentication. All API requests must include your API key as a Bearer token in the Authorization header. The API key grants access to your private contact data and workspace resources, so it should be kept secure and not shared outside your organization.

  1. Log in to your Gist account at app.getgist.com.

  2. Click Settings in the top navigation menu.

  3. In the left-hand menu, locate the Integrations or API & Integrations section and click API Key.

  4. Your API key will be displayed on this page. Click the Copy button to copy the key to your clipboard.

    Store your API key in a secure location. Your API key provides access to all data in your Gist workspace. If you believe your key has been compromised, you can regenerate it from the same settings page. Regenerating the key will invalidate the previous key immediately.

  5. Note the API base URL: https://api.getgist.com. All Gist API requests are made to this base URL and must use HTTPS—requests over plain HTTP will be rejected.

For complete reference information about the Gist API, visit the Gist Developer Hub.

Important

The Gist API is rate-limited to 100 requests per 10 seconds per workspace. When configuring high-volume data flows, plan your ingestion schedules to stay within this limit to avoid API errors.

Create a Gist Credential​

  • To create a new Gist 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 to 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​

  1. Enter your Gist API key in the API Key field. This key authenticates all requests Nexla makes to the Gist API on your behalf. The key should be copied directly from your Gist workspace settings under Settings > API Key.

    Your API key is a unique identifier tied to your Gist workspace. Nexla uses it to authenticate as your account when retrieving or sending data. Ensure the key has not expired or been regenerated since you copied it.

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.