Campayn Data Source

The Campayn connector enables you to ingest contacts, lists, email campaigns, sign-up forms, and campaign reporting data from your Campayn account. Follow the instructions below to create a new data flow that ingests data from a Campayn source in Nexla.

Campayn

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

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

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

  This endpoint returns all contacts across the entire Campayn account, regardless of list membership. Use it to build a complete, account-wide view of your contact base.

  • This endpoint requires no additional configuration. After selecting it, proceed to test and save the source.
  • Each element of the returned array is treated as an individual contact record.

  Use this endpoint when you need every contact in the account. To retrieve only the contacts in a specific list, use the "List Contacts" endpoint instead.

  List Contacts

  This endpoint returns all contacts in a single mailing list. Use it when you want to ingest the membership of a specific list.

  • Enter the identifier of the mailing list in the List ID field. You can obtain available list IDs by first configuring a source with the "List All Lists" endpoint.
  • Each element of the returned array is treated as an individual contact record.

  The List ID is required for this endpoint. Confirm the ID corresponds to an existing list in your Campayn account before testing.

  Get Contact

  This endpoint returns detailed information for a single contact identified by its ID. Use it to enrich or verify the details of a specific contact.

  • Enter the unique identifier of the contact in the Contact ID field.
  • The response contains a single contact object, which is treated as one record.

  Contact IDs can be obtained from the "List All Contacts", "List Contacts", or "Search Contacts" endpoints.

  Search Contacts

  This endpoint searches contacts across all lists by keyword, matching on name, email, or company. Use it to ingest only the contacts that match a specific search term.

  • Enter the keyword to search for in the Search Query field. Campayn matches this term against contact name, email, and company values.
  • Each element of the returned array is treated as an individual matching contact record.

  The Search Query is required. Use a specific term to narrow results, or a broader term to capture more contacts.

  List All Lists

  This endpoint returns all mailing lists in the Campayn account. Use it to inventory your lists or to obtain list IDs for use with other endpoints.

  • This endpoint requires no additional configuration. After selecting it, proceed to test and save the source.
  • Each element of the returned array is treated as an individual list record.

  The list IDs returned here can be used as input for the "List Contacts" and "Get Contact List" endpoints.

  Get Contact List

  This endpoint returns details for a single contact list identified by its ID. Use it to retrieve metadata about a specific list.

  • Enter the unique identifier of the contact list in the List ID field.
  • The response contains a single list object, which is treated as one record.

  List IDs can be obtained from the "List All Lists" endpoint.

  List Emails

  This endpoint returns all emails and campaigns in the Campayn account. Use it to ingest a complete catalog of your email campaigns.

  • This endpoint requires no additional configuration. After selecting it, proceed to test and save the source.
  • Each element of the returned array is treated as an individual email campaign record.

  Use the email IDs returned here with the "Get Email Campaign" or "Get Email Campaign Report" endpoints to retrieve further detail.

  Get Email Campaign

  This endpoint returns details for a single email campaign identified by its ID. Use it to retrieve the full configuration and content of a specific campaign.

  • Enter the identifier of the email campaign in the Email ID field.
  • The response contains a single email object, which is treated as one record.

  Email IDs can be obtained from the "List Emails" endpoint.

  Get Email Campaign Report

  This endpoint returns reporting statistics, such as opens, clicks, bounces, and unsubscribes, for a specific email campaign. Use it to analyze the performance of an individual campaign.

  • Enter the identifier of the email campaign in the Email ID field.
  • The response contains a single report object, which is treated as one record.

  Email IDs can be obtained from the "List Emails" endpoint.

  List All Campaign Reports

  This endpoint returns reports across all email campaigns for the authenticated account. Use it to ingest aggregate campaign reporting in a single source.

  • This endpoint requires no additional configuration. After selecting it, proceed to test and save the source.
  • Each element of the returned array is treated as an individual report record.

  For reporting scoped to a single campaign, use the "Get Email Campaign Report" endpoint instead.

  Get Calendar Reports

  This endpoint returns calendar-based reporting data for email campaigns in the account. Use it to ingest campaign reporting organized by date.

  • This endpoint requires no additional configuration. After selecting it, proceed to test and save the source.
  • Each element of the calendar reports array in the response is treated as an individual record.

  This endpoint is useful for building time-based dashboards that track campaign activity across a date range.

  List Forms

  This endpoint returns all sign-up forms associated with mailing lists in the Campayn account. Use it to inventory your forms or to obtain form IDs.

  • This endpoint requires no additional configuration. After selecting it, proceed to test and save the source.
  • Each element of the returned array is treated as an individual form record.

  Use the form IDs returned here with the "Get Signup Form" endpoint to retrieve detail for a specific form.

  Get Signup Form

  This endpoint returns details for a single sign-up form identified by its ID. Use it to retrieve the configuration of a specific form.

  • Enter the identifier of the sign-up form in the Form ID field.
  • The response contains a single form object, which is treated as one record.

  Form IDs can be obtained from the "List Forms" 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

Campayn data sources can be manually configured to ingest data from any valid Campayn 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 Campayn 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 Campayn API from the Method pulldown menu. Campayn read operations use GET.

API Endpoint URL

3. Enter the URL of the Campayn 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. Campayn API endpoints follow the pattern `https://{subdomain}.campayn.com/api/v1/{resource}.json`, where {subdomain} is your account subdomain.

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.

Macros are particularly useful for APIs that require date ranges 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.

Path to Data

Optional

If only a subset of the data that will be returned by the 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 wrap records inside a named object or array.

For example, the Campayn "Get Contact" endpoint returns the contact inside a top-level contact object, while list endpoints return a top-level array of records. By entering the path to the relevant data, you can configure Nexla to treat the correct element 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., $.contact to access a single contact object, or $[*] to access each element of a top-level array).
  Path to Data Example:

  For the Campayn "Get Email Campaign" endpoint, which returns the campaign inside a top-level email object, the path to data would be entered as $.email.

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.

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 or content type specifications.

  You do not need to include any headers already present in the credentials. The Authorization header used for Campayn's TRUEREST authentication is 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 Campayn 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.