Skip to main content

Authorization

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

ChurnKey

Prerequisites​

To connect Nexla to ChurnKey, you will need an active ChurnKey account along with a Data API key and your App ID. ChurnKey authenticates all Data API and Event Tracking API requests using two values passed as request headers: the API key in the x-ck-api-key header and the App ID in the x-ck-app header.

Locate Your App ID​

Your App ID is a unique identifier for your ChurnKey application and is required on every API request.

  1. Sign in to the ChurnKey dashboard at app.churnkey.co.

  2. Navigate to Settings > Account.

  3. Locate your App ID in the account details. This value is sent in the x-ck-app header on every request.

Generate a Data API Key​

ChurnKey uses a dedicated Data API key for server-to-server integrations. This key is distinct from the Cancel Flow (client-side) API key — using the Cancel Flow key for Data API requests will result in 401 or 403 authorization errors.

  1. In the ChurnKey dashboard, navigate to Settings > Account.

  2. Locate the Data API section, and copy or generate your Data API key. Data API keys are typically prefixed with data_.

  3. Store this key securely. It grants programmatic access to your cancel session data, customer events, and GDPR (Data Subject Request) operations.

    Keep your Data API key secure

    The Data API key provides full access to read session data and to create, update, and delete customer records and events. Treat it like a password, and never expose it in client-side code or public repositories.

For complete details about the ChurnKey Data API and authentication, refer to the ChurnKey Data API documentation.

Create a ChurnKey Credential​

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

ChurnKey uses API key authentication, with the Data API key and App ID passed as request headers. Both values are required for Nexla to authenticate to your ChurnKey account.

  1. Enter your ChurnKey Data API key in the API Key field. Nexla sends this value in the x-ck-api-key request header to authenticate each API call. This field is required and is stored securely.

  2. Enter your ChurnKey App ID in the App ID field. Nexla sends this value in the x-ck-app request header on every request. This field is required and identifies your ChurnKey application. Your App ID is found under Settings > Account in the ChurnKey dashboard.

    Nexla validates the credential by issuing a test request to the ChurnKey sessions endpoint. If validation fails, confirm that the API key is a Data API key (not a Cancel Flow key) and that the App ID matches the one shown in your ChurnKey account.

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.