Campayn Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Campayn location.

Campayn

Create a Campayn Destination

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

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

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

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

  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.

Configure Manually

Campayn destinations can be manually configured to send data to any valid Campayn API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Campayn 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 Campayn API from the Method pulldown menu. Campayn write operations use POST to create resources or trigger actions, PUT to update existing resources, and DELETE to remove resources.

Data Format

3. Select the format in which the Nexset data will be sent to the Campayn API from the Content Format pulldown menu. The Campayn API accepts and returns JSON only, so select the JSON format. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL

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

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

  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.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this Campayn destination, select the attributes from the Exclude Attributes pulldown menu.

• Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional

1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

   Property Inside JSON Object

   1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
   2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

   Code

   1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook

Optional

Nexla can automatically send the response received from the Campayn API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as the ID of a newly created contact, list, or campaign.

• To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the Campayn API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

• Click on a sample request payload to expand it and view the complete payload content.
• Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)

After all endpoint settings have been configured, Nexla can send a test payload to the Campayn API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Campayn API using the current settings.

Save & Activate the Destination

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