Skip to main content

ConvertKit Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to a ConvertKit location.
convertkit_api.png

ConvertKit

Create a ConvertKit Destination​

  1. Click the + icon on the Nexset that will be sent to the ConvertKit destination, and select the Send to Destination option from the menu.

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

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

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

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ConvertKit endpoints. Each template is designed specifically for the corresponding ConvertKit endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Add subscriber

    This endpoint subscribes an email address to the resource. Use this endpoint when you need to add subscribers to forms, sequences, or tags from your data sources.

    • Enter the resource type in the Resource Type field. This should be the type of resource to which you want to subscribe the email address (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) to which you want to subscribe the email address.

    • The endpoint uses POST requests to https://api.convertkit.com/v3/{'{resource_type}'}/{'{resource_id}'}/subscribe?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 sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the subscriber data to add. The request body should follow the ConvertKit API v3 specification for adding subscribers, including required fields and field names.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to add a subscriber. If you need to add multiple subscribers, you can send multiple records, but each will be processed as a separate request.

    Resource IDs can be obtained from the "List resources" data source endpoint by selecting the appropriate resource type, which returns all resources with their corresponding IDs. The request body must be properly formatted JSON that matches the ConvertKit API v3 specification for adding subscribers. The endpoint requires API Secret Key authentication via the api_secret query parameter, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about adding subscribers, including required fields, field names, and request formats, see the ConvertKit API documentation.

    Create a resource

    This endpoint creates resources such as a broadcast or a webhook to send events. Use this endpoint when you need to create new resources in your ConvertKit account from your data sources.

    • Enter the resource type you want to create in the Resource Type field. This should be the type of resource you want to create (e.g., broadcasts, webhooks). The resource type determines which resource will be created.

    • The endpoint uses POST 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 sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the resource data to create. The request body should follow the ConvertKit API v3 specification for creating resources, including required fields and field names.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a resource. If you need to create multiple resources, you can send multiple records, but each will be processed as a separate request.

    Resource types should match the ConvertKit API v3 specification. Common resource types include broadcasts and webhooks. The request body must be properly formatted JSON that matches the ConvertKit API v3 specification for creating resources. The endpoint requires API Secret Key authentication via the api_secret query parameter, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating resources, including required fields, field names, and request formats, see the ConvertKit API documentation.

Configure Manually​

ConvertKit destinations can be manually configured to send data to 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.

Using manual configuration, you can also configure Nexla to automatically send the response received from the ConvertKit API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, 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 ConvertKit API v3 primarily uses POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources or performing actions (e.g., adding subscribers, creating resources)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

Data Format​

  1. Select the format in which the Nexset data will be sent to the ConvertKit API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The ConvertKit API v3 typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the ConvertKit API endpoint to which you want to send the Nexset data in the 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.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, 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 authentication 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. The ConvertKit API v3 requires API Secret Key authentication via the api_secret query parameter, which is handled automatically by your credential configuration. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. ConvertKit API v3 endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

Save the Destination​

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

  2. The destination will now be available in your data flow and will begin sending data to the ConvertKit endpoint according to the configured settings.