Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a ConvertKit source in Nexla.
convertkit_api.png

ConvertKit

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

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

    ConvertKit sources can also be configured manually, allowing you to ingest data from ConvertKit 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 ConvertKit endpoints. Each template is designed specifically for the corresponding ConvertKit 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 resources

    This endpoint lists all resources in the creator account. Use this endpoint when you need to access resource information, such as forms, sequences, tags, or other resources in your ConvertKit account.

    • Enter the resource type you want to retrieve in the Resource Type field. This should be the type of resource you want to list (e.g., forms, sequences, tags, subscribers). The resource type determines which resources will be retrieved.

    • The endpoint uses GET requests to https://api.convertkit.com/v3/{'{resource_type}'}?api_secret={'{api_secret}'} where {resource_type} is the resource type you provide and {api_secret} is your API Secret Key from the credential configuration. The endpoint URL is automatically constructed based on the ConvertKit API base URL, the resource type, and your credential's API Secret Key.
    • The endpoint does not use pagination and returns all resources of the specified type in a single request.
    • The endpoint will return all resources of the specified type. The response data is extracted from the root-level object in the API response ($), and Nexla will process the entire response structure.

    Resource types should match the ConvertKit API v3 specification. Common resource types include forms, sequences, tags, subscribers, and account. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $, which extracts the entire root-level object from the API response. You can use the advanced tab for fetching a filtered list of resources. For detailed information about listing resources, see the ConvertKit API documentation.

    Get Statistics

    This endpoint gets statistics for a specific broadcast. Use this endpoint when you need to access broadcast performance metrics, engagement statistics, or analytics data for a specific broadcast in your ConvertKit account.

    • Enter the broadcast ID for which you want to retrieve statistics in the Broadcast ID field. This is the unique identifier of the broadcast for which you want to get statistics.

    • The endpoint uses GET requests to https://api.convertkit.com/v3/broadcasts/{'{broadcast_id}'}/stats?api_secret={'{api_secret}'} where {broadcast_id} is the broadcast ID you provide and {api_secret} is your API Secret Key from the credential configuration. The endpoint URL is automatically constructed based on the ConvertKit API base URL, the broadcast ID, and your credential's API Secret Key.
    • The endpoint does not use pagination and returns the complete broadcast statistics in a single request.
    • The endpoint will return statistics for the specified broadcast. The response data is extracted from the broadcast array in the API response ($.broadcast[*]), with each statistic record processed individually.

    Broadcast IDs can be obtained from other ConvertKit API endpoints, such as the List resources endpoint by selecting broadcasts as the resource type, which returns all broadcasts with their corresponding IDs. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.broadcast[*], which extracts all items from the broadcast array in the API response. For detailed information about getting broadcast statistics, see the ConvertKit API documentation.

    List subscriptions

    This endpoint lists subscriptions to a resource including subscriber data. Use this endpoint when you need to access subscription information, subscriber details, or subscription data for a specific resource (form, sequence, or tag) in your ConvertKit account.

    • Enter the resource type in the Resource Type field. This should be the type of resource for which you want to list subscriptions (e.g., forms, sequences, tags).

    • Enter the resource ID in the Resource ID field. This is the unique identifier of the specific resource (form, sequence, or tag) for which you want to list subscriptions.

    • The endpoint uses GET requests to https://api.convertkit.com/v3/{'{resource_type}'}/{'{resource_id}'}/subscriptions?api_secret={'{api_secret}'} where {resource_type} is the resource type, {resource_id} is the resource ID you provide, and {api_secret} is your API Secret Key from the credential configuration. The endpoint URL is automatically constructed based on the ConvertKit API base URL, the resource type and ID, and your credential's API Secret Key.
    • The endpoint does not use pagination and returns all subscriptions for the specified resource in a single request.
    • The endpoint will return all subscriptions to the specified resource, including subscriber data. The response data is extracted from the subscriptions array in the API response ($.subscriptions[*]), with each subscription record processed individually.

    Resource IDs can be obtained from the List resources endpoint by selecting the appropriate resource type, which returns all resources with their corresponding IDs. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.subscriptions[*], which extracts all items from the subscriptions array in the API response. For detailed information about listing subscriptions, see the ConvertKit API documentation.

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​

ConvertKit data sources can be manually configured to ingest data from any valid ConvertKit API v3 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 ConvertKit sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or 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 ConvertKit API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the ConvertKit 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. ConvertKit API endpoints typically follow the pattern https://api.convertkit.com/v3/{'{endpoint_path}'}. Remember to include the api_secret query parameter with your API Secret Key.

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. The endpoint requires API Secret Key authentication via the api_secret query parameter, which is handled automatically by your credential configuration. For detailed information about ConvertKit API endpoints and available APIs, see the ConvertKit API documentation.

Path to Data​

  1. Enter the JSON path that identifies the location of the relevant data within the API response in the Path to Data field. JSON paths use dot notation to navigate through nested JSON structures.

    • For example, if your API response has the structure {"subscriptions": [...]}, you would enter $.subscriptions[*] to extract all items from the subscriptions array.
    • Use $[*] to extract all items from a root-level array.
    • Use $ to extract the entire root-level object.

JSON paths are case-sensitive and must match the exact structure of your API response. ConvertKit API responses may use different structures like subscriptions arrays or root-level objects depending on the endpoint. Use the Test button to verify that your JSON path correctly extracts the desired data from the API response.

Save the Data Source​

  1. Once all configuration steps have been completed, click the Save button to save your data source configuration.

  2. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.