Skip to main content

Authorization

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

Appcues

Prerequisites​

The Appcues Public API (V2) uses HTTP Basic Authentication. Every request must include an API key and API secret pair issued from the Appcues Studio, along with your Appcues account ID embedded in the request URL. Gather all three values before creating the credential in Nexla.

Locate Your Appcues Account ID​

Your Appcues account ID is a numeric identifier that scopes every API call to your organization's data. It is shown in your Appcues Studio account settings.

  1. Sign in to Appcues Studio at studio.appcues.com.

  2. From the main navigation, open Settings.

  3. Select the Account tab. Your numeric Account ID is displayed at the top of this page.

  4. Copy the Account ID value and store it for use when configuring the credential in Nexla.

    The account ID also appears in the Appcues Studio URL after you sign in (for example, studio.appcues.com/accounts/12345/...). For complete reference, see the Appcues Public API documentation.

Generate an API Key and Secret​

API keys and secrets for the V2 Public API are created in the Appcues Studio. Only account admins can issue new keys.

  1. Sign in to Appcues Studio at studio.appcues.com as an account admin.

  2. Navigate to Settings > Integrations > API Keys. This page lists any existing keys and provides a button to create a new one.

  3. Click Create new key to open the key creation dialog.

  4. Enter a descriptive name for the key in the Name field (for example, Nexla integration). The name helps you identify which integration the key is associated with when reviewing the keys list later.

  5. Select the desired permission level for the key:

    • Publisher: Grants read access plus the ability to publish or unpublish experiences (flows, checklists, banners, launchpads, pins, mobile experiences). Choose this level for integrations that manage experience lifecycle.

    • Admin: Grants full access to all V2 API endpoints, including segment management and user event tracking. Choose this level when the integration must create or update segments, add users to segments, or write user events.

  6. Click Create to generate the key. Appcues displays both the API Key and the API Secret in a confirmation dialog.

    Important

    The API Secret is displayed only once at creation. Copy both the API Key and the API Secret immediately and store them in a secure secret manager — Appcues does not show the secret again after you close the dialog. If the secret is lost, you must delete the key and create a new one.

  7. Confirm that the new key appears in the API Keys list at the expected permission level.

For complete information about creating and managing keys, see the Appcues Public API guide and the Appcues API V2 reference.

Important

The legacy v1 Appcues API key (used by the Appcues SDK and v1 activity tracking) is not interchangeable with the V2 key/secret pair. Always use a V2 key/secret created from the API Keys page for this connector.

Create an Appcues Credential​

  • To create a new Appcues 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.

Authentication Settings​

  1. Enter the API Key value generated from Settings > Integrations > API Keys in Appcues Studio into the Username Or API Key field. This value is the public portion of the key pair and is sent as the HTTP Basic Auth username on every request.

  2. Enter the matching API Secret value (shown only once at key creation) into the Password field. Nexla stores this value as a secret and uses it as the HTTP Basic Auth password on every request.

    If the API secret has been lost, return to Settings > Integrations > API Keys in Appcues Studio, delete the existing key, and create a new key/secret pair. The previous secret cannot be recovered.

  3. Enter your numeric Appcues Account ID into the Account ID field. This value is read from Settings > Account in Appcues Studio and is interpolated into every Appcues API request URL (for example, https://api.appcues.com/v2/accounts/{account_id}/flows).

    Nexla validates this credential by issuing a GET request to https://api.appcues.com/v2/accounts/{account_id}/launchpads with the supplied key and secret. A successful response confirms that all three values are correct and that the key has at least read access.

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.