Skip to main content

ConfigCat Data Source

The ConfigCat connector enables you to ingest feature flag and configuration management data from the ConfigCat Public Management API, including organizations, products, configs, environments, feature flags (settings), flag values, segments, webhooks, and audit logs. Follow the instructions below to create a new data flow that ingests data from a ConfigCat source in Nexla.
config_cat_api.png

ConfigCat

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 ConfigCat connector tile from the list of available connectors. Then, select the credential that will be used to connect to the ConfigCat instance, and click Next; or, create a new ConfigCat credential for use in this flow.

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

    ConfigCat sources can also be configured manually, allowing you to ingest data from ConfigCat 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 ConfigCat endpoints. Each template is designed specifically for the corresponding ConfigCat endpoint, making data source setup easy and efficient.

In ConfigCat, resources are organized hierarchically: an organization contains products, each product contains configs and environments, and each config contains settings (feature flags). Many of the endpoints below require the ID of a parent resource. These IDs are GUID-style identifiers that can be retrieved using the corresponding list endpoints (for example, run List Products to obtain product IDs, then List Configs to obtain config IDs) or copied from the ConfigCat Dashboard.

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 Organizations

    This endpoint returns a list of all organizations accessible to the authenticated user. Use it to discover the organizations available to your ConfigCat account and obtain their IDs for use with other endpoints.

    • This endpoint requires no additional configuration. Select it to retrieve all organizations that your Public API credentials can access.

    Organization IDs returned by this endpoint are required by the List Audit Logs endpoint and can help you navigate to the products within each organization.

    List Products

    This endpoint retrieves a list of all products from ConfigCat. Use it to discover the products in your account and obtain the product IDs needed by config, environment, segment, and webhook endpoints.

    • This endpoint requires no additional configuration. Select it to retrieve all products accessible to your credentials.

    Get Product

    This endpoint retrieves a single product by its ID. Use it when you need detailed information about one specific product rather than the full list.

    • Enter the ID of the product to retrieve in the Product ID field. Product IDs can be obtained from the List Products endpoint or copied from the ConfigCat Dashboard.

    List Configs

    This endpoint returns a list of all configs in a product. A config is a collection of related feature flags and settings that are managed together.

    • Enter the ID of the product whose configs to list in the Product ID field. Product IDs can be obtained from the List Products endpoint.

    Get Config

    This endpoint retrieves the details of a specific config, including its name and description. Use it when you need information about one config rather than the full list within a product.

    • Enter the ID of the config to retrieve in the Config ID field. Config IDs can be obtained from the List Configs endpoint.

    List Environments

    This endpoint returns a list of all environments for a product. Environments (for example, Production, Staging, or Test) let you maintain separate feature flag values for different deployment targets.

    • Enter the ID of the product for which to list environments in the Product ID field. Product IDs can be obtained from the List Products endpoint.

    Get Environment

    This endpoint retrieves the details of a specific environment by ID, including its name, description, and color.

    • Enter the ID of the environment to retrieve in the Environment ID field. Environment IDs can be obtained from the List Environments endpoint.

    List Flags

    This endpoint retrieves a list of all feature flags (settings) in a config, including their metadata such as name, key, and type. Use it to review the flags defined within a config.

    • Enter the ID of the config whose flags to list in the Config ID field. Config IDs can be obtained from the List Configs endpoint.

    In the ConfigCat Public Management API, a feature flag is referred to as a "setting." The IDs returned by this endpoint can be used as the Setting ID in the Get Setting and Get Setting Value endpoints.

    Get Setting

    This endpoint retrieves the metadata of a single feature flag (setting) by its ID, including its name, key, hint, tags, and type.

    • Enter the ID of the feature flag setting to retrieve in the Setting ID field. Setting IDs can be obtained from the List Flags endpoint.

    Get Setting Values

    This endpoint retrieves all flag values for a specific environment in a config. Use it to capture the complete set of feature flag values that apply to a given config and environment combination.

    • Enter the ID of the config in the Config ID field. Config IDs can be obtained from the List Configs endpoint.
    • Enter the ID of the environment to retrieve flag values for in the Environment ID field. Environment IDs can be obtained from the List Environments endpoint.

    Get Setting Value

    This endpoint retrieves the current value and configuration of a single feature flag setting in a specific environment, including targeting rules and rollout percentages.

    • Enter the ID of the environment containing the setting in the Environment ID field. Environment IDs can be obtained from the List Environments endpoint.
    • Enter the ID of the feature flag setting to retrieve in the Setting ID field. Setting IDs can be obtained from the List Flags endpoint.

    Get SDK Key

    This endpoint retrieves the SDK key for a specific environment within a config. SDK keys are used by ConfigCat SDKs to connect applications to a particular config and environment for flag evaluation.

    • Enter the ID of the config in the Config ID field. Config IDs can be obtained from the List Configs endpoint.
    • Enter the ID of the environment to get the SDK key for in the Environment ID field. Environment IDs can be obtained from the List Environments endpoint.

    List Segments

    This endpoint returns the list of targeting segments defined for a product. Segments are reusable groups of users that can be referenced by targeting rules across feature flags.

    • Enter the ID of the product whose segments to list in the Product ID field. Product IDs can be obtained from the List Products endpoint.

    List Webhooks

    This endpoint returns the list of webhooks registered for a product. Webhooks notify external systems when feature flag changes occur.

    • Enter the ID of the product whose webhooks to list in the Product ID field. Product IDs can be obtained from the List Products endpoint.

    List Audit Logs

    This endpoint returns audit log events for an organization. Audit logs record changes made to ConfigCat resources and are useful for compliance, monitoring, and change-tracking workflows.

    • Enter the ID of the organization whose audit logs to retrieve in the Organization ID field. Organization IDs can be obtained from the List Organizations endpoint.

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​

ConfigCat data sources can be manually configured to ingest data from any valid ConfigCat Public Management API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex ConfigCat sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

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 ConfigCat API from the Method pulldown menu. ConfigCat read operations use the GET method:

    • GET: For retrieving data from the API

API Endpoint URL​

  1. Enter the URL of the ConfigCat API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters—for example, https://api.configcat.com/v1/products to list products, or https://api.configcat.com/v1/products/{'{productId}'}/configs to list the configs within a product.

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.

Path to Data​

Optional

If only a subset of the data returned by an API 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. This is particularly useful when API responses contain metadata, nested objects, or other data that you don't need for your analysis.

Many ConfigCat list endpoints (such as List Products, List Configs, and List Environments) return a top-level JSON array, in which case each element of the array should be treated as a record.

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 (e.g., $.data.items[*] to access an array of items within a data object).
    Path to Data Example:

    For a ConfigCat endpoint that returns a top-level array (such as List Products), enter $[*] to treat each element of the array as a record. For an endpoint that returns a single object (such as Get Config), enter $ to treat the entire response as one record.

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.

    PathSuggestions.png

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.

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • 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 (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration.

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 ConfigCat 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.