Campayn is an email marketing and automation platform that lets you build and send email campaigns, manage contacts and lists, create sign-up forms, and track campaign performance. The Campayn connector uses the Campayn REST API to read marketing data into Nexla and push contacts, lists, campaigns, and forms back to your Campayn account.
Power end-to-end data operations for your Campayn API with Nexla. Our bi-directional Campayn connector is purpose-built for Campayn, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Campayn or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Campayn workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
To connect Nexla to Campayn, you need an active Campayn account and an API key generated from that account. Campayn authenticates API requests using API key authentication with the TRUEREST scheme, in which your key is passed in the Authorization request header. Nexla constructs this header automatically once you provide your API key.
Every Campayn API request is made against your account's dedicated subdomain (for example, mycompany.campayn.com), so you also need to know the subdomain for your account.
Campayn provisions each account on its own subdomain in the form {subdomain}.campayn.com. Your subdomain is the portion of the URL that appears before .campayn.com when you are signed in to your Campayn dashboard.
Sign in to your Campayn account.
Note the address shown in your browser's address bar (for example, https://mycompany.campayn.com).
The text before .campayn.com is your subdomain. In the example above, the subdomain is mycompany.
Locate the API section, and copy the API key that is displayed for your account.
Anyone who has your API key can access your Campayn data, including reports and lists, so treat it as securely as your username and password. If you believe your key has been compromised, regenerate it from your Campayn account settings.
Campayn uses API key authentication. Provide the API key and account subdomain so that Nexla can authenticate to your account and build the correct base URL for every API request.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Enter your Campayn API key in the API Key field. This key authenticates Nexla with Campayn and should be kept secure. Nexla passes it in the Authorization header using Campayn's TRUEREST scheme.
Enter your account subdomain in the Subdomain field (for example, mycompany for mycompany.campayn.com). This value is required so that Nexla can construct the base URL for every Campayn API request.
Enter only the subdomain itself, not the full host name. For an account hosted at mycompany.campayn.com, enter mycompany.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Campayn connector tile, 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.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Campayn endpoints. 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.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Campayn data sources can also be manually configured to ingest data from any valid Campayn API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Campayn read operations use the GET method, and Campayn API endpoints follow the pattern https://{subdomain}.campayn.com/api/v1/{resource}.json, where {subdomain} is your account subdomain. Some responses wrap records in a named object—for example, the "Get Contact" endpoint returns the contact inside a top-level contact object, and the "Get Email Campaign" endpoint returns the campaign inside a top-level email object (path to data $.email). The Authorization header used for Campayn's TRUEREST authentication is handled automatically by Nexla and does not need to be added as a request header.
Once all of the relevant settings have been configured, 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.
Click the + icon on the Nexset that will be sent to the Campayn destination, and select the Send to Destination option from the menu. Select the Campayn connector from the list of available destination connectors, then select the credential that will be used to connect to the Campayn account, and click Next; or, create a new Campayn credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Campayn endpoints. 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.
Create Contact
This endpoint creates a new contact and subscribes them to a specified contact list. Use it to push new contacts from your Nexla flow into Campayn.
Enter the identifier of the list to subscribe the contact to in the List ID field. You can obtain list IDs from the "List All Lists" source endpoint.
Each record in the Nexset is sent as the contact payload (for example, email and name fields) in a POST request.
The List ID is required for this endpoint. Ensure each record contains the contact fields expected by Campayn, such as the contact's email address.
Update Contact
This endpoint updates an existing contact's information by ID. Use it to keep Campayn contact records in sync with your source data.
Enter the unique identifier of the contact to update in the Contact ID field.
Each record in the Nexset is sent as the updated contact payload in a PUT request.
Contact IDs can be obtained from the "List All Contacts", "List Contacts", or "Search Contacts" source endpoints.
Delete Contact
This endpoint deletes a contact by its ID. Use it to remove contacts from Campayn based on your source data.
Enter the unique identifier of the contact to delete in the Contact ID field.
The request is sent to Campayn using the DELETE method.
Deleting a contact is permanent. Confirm the Contact ID before activating this destination.
Unsubscribe Contact
This endpoint unsubscribes a contact from a list by contact ID or email address. Use it to honor opt-out requests or manage list membership.
Enter the identifier of the list to unsubscribe from in the List ID field.
Each record in the Nexset is sent as the payload identifying the contact (by ID or email) to unsubscribe.
The List ID is required for this endpoint.
Create Contact List
This endpoint creates a new contact list for the authenticated account. Use it to provision new mailing lists from your Nexla flow.
This endpoint requires no additional parameters. Each record in the Nexset is sent as the new list payload in a POST request.
Ensure each record contains the list fields expected by Campayn, such as the list name.
Update Contact List
This endpoint updates an existing contact list's information by ID. Use it to keep list metadata in sync with your source data.
Enter the unique identifier of the contact list to update in the List ID field.
Each record in the Nexset is sent as the updated list payload in a PUT request.
List IDs can be obtained from the "List All Lists" source endpoint.
Delete Contact List
This endpoint deletes a contact list by ID. Use it to remove mailing lists from Campayn.
Enter the identifier of the contact list to delete in the List ID field.
The request is sent to Campayn using the DELETE method.
Deleting a list is permanent and removes the list's association with its contacts. Confirm the List ID before activating this destination.
Create Email Campaign
This endpoint creates a new email campaign. Use it to generate campaigns in Campayn from content prepared in your Nexla flow.
This endpoint requires no additional parameters. Each record in the Nexset is sent as the new email campaign payload in a POST request.
After creating a campaign, use the "Send Email Campaign" endpoint to trigger its delivery.
Update Email Campaign
This endpoint updates an existing email campaign. Use it to revise campaign content or settings before sending.
Enter the identifier of the email campaign to update in the Email ID field.
Each record in the Nexset is sent as the updated campaign payload in a PUT request.
Email IDs can be obtained from the "List Emails" source endpoint.
Delete Email Campaign
This endpoint deletes an email campaign by ID. Use it to remove campaigns from Campayn.
Enter the identifier of the email campaign to delete in the Email ID field.
The request is sent to Campayn using the DELETE method.
Deleting a campaign is permanent. Confirm the Email ID before activating this destination.
Send Email Campaign
This endpoint triggers sending or scheduling of a previously created email campaign. Use it to dispatch a campaign once its content is finalized.
Enter the identifier of the email campaign to send in the Email ID field.
Each record in the Nexset is sent as the payload in a POST request that triggers delivery.
The Email ID is required. Create the campaign first using the "Create Email Campaign" endpoint, then send it with this endpoint.
Create Sign-up Form
This endpoint creates a new sign-up form. Use it to provision forms in Campayn from your Nexla flow.
This endpoint requires no additional parameters. Each record in the Nexset is sent as the new form payload in a POST request.
Ensure each record contains the form fields expected by Campayn.
Update Sign-up Form
This endpoint updates an existing sign-up form by ID. Use it to keep form configuration in sync with your source data.
Enter the identifier of the sign-up form to update in the Form ID field.
Each record in the Nexset is sent as the updated form payload in a PUT request.
Form IDs can be obtained from the "List Forms" source endpoint.
Delete Sign-up Form
This endpoint deletes a sign-up form by ID. Use it to remove forms from Campayn.
Enter the identifier of the sign-up form to delete in the Form ID field.
The request is sent to Campayn using the DELETE method.
Deleting a form is permanent. Confirm the Form ID before activating this destination.
Campayn destinations can also be manually configured to send data to any valid Campayn API endpoint, including chained API calls or configurations that send the Campayn API response to a new Nexla webhook data source. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Campayn write operations use POST to create resources or trigger actions, PUT to update existing resources, and DELETE to remove resources. The Campayn API accepts and returns JSON only, so select the JSON content format. Campayn API endpoints follow the pattern https://{subdomain}.campayn.com/api/v1/{resource}.json, where {subdomain} is your account subdomain; for update or delete operations, include the ID of the object at the end of the URL. The Authorization header used for Campayn's TRUEREST authentication is handled automatically by Nexla.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to Campayn, open the destination resource menu, and select Activate.
The Nexset data will not be sent to Campayn until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
