Appcues Data Source

Appcues is a product experience platform for in-app onboarding, guidance, and analytics. Follow the instructions below to create a new data flow that ingests data from an Appcues source in Nexla.

Appcues

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the Appcues connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Appcues instance, and click Next; or, create a new Appcues credential for use in this flow.

3. In Nexla, Appcues data sources can be created using pre-built endpoint templates, which expedite source setup for common Appcues endpoints. Each template is designed specifically for the corresponding Appcues endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   Appcues sources can also be configured manually, allowing you to ingest data from Appcues endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Appcues endpoints. Each template is designed specifically for the corresponding Appcues endpoint, making data source setup easy and efficient.

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  List Flows

  This endpoint returns every web flow configured in the Appcues account, including metadata such as the flow name, status, segment targeting, and version history. Use it to sync your flow catalog into a warehouse, audit which flows are live, or feed downstream reporting.

  • No configuration is required for this endpoint beyond selecting it. All flows on the account are returned automatically as a top-level JSON array.
  • Flow IDs returned by this endpoint can be passed to the Get Flow Details endpoint to retrieve the full configuration, or to the Publish Flow / Unpublish Flow destination endpoints to change flow status.

  For the full response schema, see the List flows reference.

  Get Flow Details

  This endpoint retrieves the full record for a single flow by ID, including its steps, targeting rules, and publish state. Use it to enrich an existing dataset of flow IDs with the latest configuration details.

  • Enter the flow ID in the Flow ID field. This field is required. Flow IDs can be obtained from the List Flows endpoint or from upstream Nexla data flows.

  This endpoint returns a single flow object, not an array. The path to data is set to $.data, which maps the flow payload to a single Nexla record.

  List Checklists

  This endpoint returns every checklist configured in the Appcues account, along with metadata such as name, status, and segment targeting. Use it to sync your checklist catalog or feed downstream reporting on onboarding completion.

  • No configuration is required for this endpoint beyond selecting it. All checklists on the account are returned automatically.
  • Checklist IDs returned by this endpoint can be passed to Get Checklist Details, Publish Checklist, or Unpublish Checklist.

  Get Checklist Details

  This endpoint retrieves detailed configuration for a single checklist by ID — including each step, segment targeting, and publish state.

  • Enter the checklist ID in the Checklist ID field. This field is required. Checklist IDs can be obtained from the List Checklists endpoint.

  The path to data for this endpoint is $.data, which maps the checklist payload to a single Nexla record.

  List Banners

  This endpoint returns every banner configured in the Appcues account. Banners are slim notification bars used for announcements, calls to action, or system messages. Use it to keep a downstream catalog of banners synced or to audit which banners are live.

  • No configuration is required for this endpoint beyond selecting it. All banners on the account are returned automatically as a top-level JSON array.

  For complete details on banners, see the Appcues banners API guide.

  List Launchpads

  This endpoint returns every launchpad configured in the Appcues account. Launchpads are in-app widgets that aggregate flows, checklists, and resources for end users. Use it to sync your launchpad catalog into a warehouse or downstream reporting.

  • No configuration is required for this endpoint beyond selecting it. All launchpads on the account are returned automatically.
  • Launchpad IDs returned by this endpoint can be passed to Get Launchpad Details for the full configuration.

  Get Launchpad Details

  This endpoint retrieves detailed configuration for a single launchpad by ID, including its items, targeting rules, and publish state.

  • Enter the launchpad ID in the Launchpad ID field. This field is required. Launchpad IDs can be obtained from the List Launchpads endpoint.

  This endpoint returns a single launchpad object. The path to data is set to the response root ($), so the launchpad payload is treated as a single Nexla record.

  List Pins

  This endpoint returns every pin configured in the Appcues account. Pins are persistent in-app indicators (tooltips, hotspots) attached to specific UI elements. Use it to audit pin coverage or sync pin metadata into downstream reporting.

  • No configuration is required for this endpoint beyond selecting it. All pins on the account are returned automatically.

  List Tags

  This endpoint returns every tag defined in the Appcues account. Tags are used to organize and categorize Appcues experiences (flows, checklists, banners, etc.) and can be referenced when filtering downstream reporting.

  • No configuration is required for this endpoint beyond selecting it. All tags on the account are returned automatically.

  List Mobile Experiences

  This endpoint returns a paginated list of mobile experiences in the Appcues account. Mobile experiences are in-app messages, surveys, and flows shown in your iOS and Android apps. Use it to sync your mobile experience catalog or feed reporting on mobile in-app messaging.

  • No configuration is required for this endpoint beyond selecting it. The template requests pages of 50 records and automatically advances the offset parameter until Appcues returns an empty page.
  • Mobile experience IDs returned by this endpoint can be passed to Get Mobile Experience Details for the full configuration.

  This is the only Appcues source endpoint that uses offset-based pagination — the others return a single page of data. For details, see the List mobile experiences reference.

  Get Mobile Experience Details

  This endpoint retrieves detailed configuration for a single mobile experience by ID, including its content, targeting, and publish state.

  • Enter the mobile experience ID in the Mobile Experience ID field. This field is required. Mobile experience IDs can be obtained from the List Mobile Experiences endpoint.

  List Segments

  This endpoint returns every segment configured in the Appcues account. Segments are rule-based or list-based audiences used to target Appcues experiences. Use it to sync your segment catalog into a warehouse, audit segment usage, or feed downstream audience reporting.

  • No configuration is required for this endpoint beyond selecting it. All segments on the account are returned automatically.
  • Segment IDs returned by this endpoint can be passed to Get Segment Details, Add User IDs to Segment, or Update Segment Details.

  For complete details on segments, see the Appcues segments API guide.

  Get Segment Details

  This endpoint retrieves detailed configuration for a single segment by ID, including its targeting rules (for rule-based segments) or membership (for list-based segments).

  • Enter the segment ID in the Segment ID field. This field is required. Segment IDs can be obtained from the List Segments endpoint.

  The path to data is set to the response root ($), so the segment payload is treated as a single Nexla record.

  Publish Checklist

  This endpoint publishes a checklist, activating it for end users. It is exposed as a source-style template because the underlying call requires no request body — the checklist ID is passed in the URL and the API response (the published checklist record) is returned as the data payload.

  • Enter the checklist ID in the Checklist ID field. This field is required. Checklist IDs can be obtained from the List Checklists endpoint.
  • The endpoint issues a POST to https://api.appcues.com/v2/accounts/{'{account_id}'}/checklists/{'{checklist_id}'}/publish. The response payload (under $.data) is treated as the Nexla record so the publish action and its result can be captured in the same flow.

  Publishing a checklist makes it immediately visible to users matching its segment targeting. For complete details, see the Publish checklist reference.

  Unpublish Checklist

  This endpoint unpublishes a checklist, hiding it from end users without deleting its configuration. It is exposed as a source-style template because the underlying call requires no request body — the checklist ID is passed in the URL and the API response is returned as the data payload.

  • Enter the checklist ID in the Checklist ID field. This field is required. Checklist IDs can be obtained from the List Checklists endpoint.
  • The endpoint issues a POST to https://api.appcues.com/v2/accounts/{'{account_id}'}/checklists/{'{checklist_id}'}/unpublish. The response payload (under $.data) is treated as the Nexla record.

  Unpublishing a checklist preserves the configuration in Appcues, so it can be republished later with Publish Checklist.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Appcues data sources can be manually configured to ingest data from any valid Appcues Public API (V2) endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations — for example, calling region-specific hosts such as api.eu.appcues.com or api.appcues.net, or chaining lookup-driven calls.

With manual configuration, you can also create more complex Appcues sources, such as sources that fan out a list of flow IDs returned by List Flows into a per-flow Get Flow Details call.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Appcues API from the Method pulldown menu. The most common methods for Appcues read endpoints are:

   • GET: For retrieving data from the API (list and get endpoints)
   • POST: For publish/unpublish actions that return a payload (for example, POST /checklists/{'{id}'}/publish)

API Endpoint URL

3. Enter the URL of the Appcues API endpoint from which this source will fetch data in the Set API URL field. All Appcues V2 API URLs follow the pattern https://api.appcues.com/v2/accounts/{'{account_id}'}/{'{resource}'} (for example, https://api.appcues.com/v2/accounts/12345/flows). For regional deployments, substitute api.eu.appcues.com or api.appcues.net as the host.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. The core Appcues V2 endpoints do not accept date filters in the URL, but date/time macros can be useful when calling custom Appcues reporting endpoints or constructing date-based query parameters.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime

   • {now-1} – The datetime one time unit before the current datetime

   • {now+1} – The datetime one time unit after the current datetime

   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data. For Appcues, this is the recommended way to drive per-record calls such as Get Flow Details, Get Checklist Details, or Get Segment Details from a Nexla dataset of resource IDs.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs — for example, fetching the details for every flow ID returned by a List Flows source.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by an Appcues endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. Different Appcues endpoints return different shapes — choose the path that matches the endpoint being called.

For example, list endpoints such as /banners, /checklists, /flows, /launchpads, /pins, /segments, and /tags return a top-level JSON array, so the path is $[*]. The /mobile list endpoint returns records under $.data[*]. Single-resource endpoints such as /flows/{'{id}'} and /checklists/{'{id}'} return the record under $.data, while /launchpads/{'{id}'} and /segments/{'{id}'} return the record at the response root, so the path is $.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (for example, $.data[*] to access an array of items within a data object).
  Path to Data Example:

  For an Appcues endpoint that returns a top-level array (such as GET /flows), enter $[*] as the path to data. For a paginated endpoint such as GET /mobile, enter $.data[*]. For a single-object endpoint such as GET /flows/{'{id}'}, enter $.data.

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

The /mobile endpoint includes a meta object alongside its data[*] array containing pagination details. To preserve this pagination context with every record, set the metadata path to $.meta.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example, header1:value1,header2:value2).

  You do not need to include any headers already present in the credentials. The HTTP Basic Authorization header is added automatically based on your Appcues credential.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Appcues data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.