Babelforce Destination

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

Babelforce

Create a Babelforce Destination

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

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

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

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

  This template posts each Nexset record as a new lead on a specific Babelforce outbound call list using POST /api/v2/outbound/lists/{'{list_id}'}/leads. Use this template to push contacts into Babelforce dialer campaigns from a CRM or marketing system.

  • Enter the unique identifier of the outbound list that should receive the new leads in the List ID field. This value is required.
  • Each Nexset record is sent as the JSON request body using the {'{message.json}'} body template. Ensure the record schema matches the lead structure expected by Babelforce — at minimum, the fields required by your list configuration.

  List IDs can be retrieved with the List Outbound Lists data source endpoint or copied from the Babelforce manager app.

  Create Application

  This template creates a new application in the account using POST /api/v2/applications. Use this template to provision Babelforce applications programmatically from configuration stored in another system.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the JSON payload expected by the Babelforce Applications API.

  Create Calendar

  This template creates a new calendar in the account using POST /api/v2/calendars. Use this template to bulk-load business calendars from a source-of-truth system into Babelforce.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the JSON payload expected by the Babelforce Calendars API.

  Create Outbound Campaign

  This template creates a new outbound dialer campaign using POST /api/v2/outbound/campaigns. Use this template to provision campaigns programmatically — for example, as part of a regular cadence-creation process driven by a marketing platform.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the full campaign JSON payload expected by the Babelforce Campaigns API.

  Create Conversation

  This template creates a new conversation session using POST /api/v2/conversations. Use this template when external systems initiate conversations that must be tracked in Babelforce as multi-leg interactions.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the conversation JSON payload expected by the Babelforce Conversations API.

  Create Outbound List

  This template creates a new outbound list for use in dialer campaigns using POST /api/v2/outbound/lists. Pair with Add Outbound Lead to first create the list, then load leads into it.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the JSON payload expected by the Babelforce Outbound Lists API.

  Create Session

  This template creates a new session for managing call or communication state using POST /api/v2/sessions. Use this template in automations that need to bootstrap session context before subsequent API calls.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the session JSON payload expected by the Babelforce Sessions API.

  Create Trigger

  This template creates a new automation trigger using POST /api/v2/triggers. Use this template to provision event-driven rules from configuration in another system.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the trigger JSON payload expected by the Babelforce Triggers API.

  Create User

  This template creates a new user in the account using POST /api/v2/users. Use this template for native Babelforce user provisioning from an HR or identity source.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the user JSON payload expected by the Babelforce Users API.

  For environments managed by an identity provider, prefer the Create User (SCIM) template, which expects the SCIM 2.0 user schema.

  Create User (SCIM)

  This template creates a new user via the SCIM 2.0 protocol using POST /auth/scim/v2/Users. Use this template when provisioning users from an identity provider or governance tool that emits SCIM-shaped payloads.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must conform to the SCIM 2.0 user schema.

  Send SMS

  This template sends an SMS through Babelforce using POST /api/v2/sms. Use this template to drive outbound SMS — for notifications, marketing follow-ups, or appointment reminders — from a Nexla data flow.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the SMS payload expected by the Babelforce SMS API, including the recipient phone number and the message body.

  Validate phone numbers in E.164 format upstream of this destination to avoid bulk rejection by Babelforce.

  Start Sync

  This template starts an environment synchronization run via the Env Sync API. Use this template to trigger sync jobs between paired Babelforce environments (for example, sandbox and production) on a schedule or in response to an upstream event.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the sync-job payload expected by the Babelforce Env Sync API.

  Submit Task

  This template submits a new task to Babelforce using POST /api/v2/tasks. Use this template to inject work items into the Babelforce task queue from upstream automations.

  • This endpoint requires no additional parameters in Nexla. Each Nexset record must contain the task payload expected by the Babelforce Tasks API.

  Update Campaign

  This template updates an existing outbound dialer campaign using PUT /api/v2/outbound/campaigns/{'{id}'}. Use this template to push configuration changes — for example, adjusting cadence, status, or assignments — into Babelforce.

  • Each Nexset record must include the campaign identifier and the updated campaign payload expected by the Babelforce Campaigns API.

  The campaign ID is typically included as a field in the Nexset record and substituted into the URL via the request template at runtime.

  Update Session Variables

  This template updates the variables and state on an existing session using PUT /api/v2/sessions/{'{session_id}'}. Use this template to propagate context changes — such as customer attributes or routing decisions — into active sessions.

  • Each Nexset record must include the session identifier and the updated variables payload expected by the Babelforce Sessions API.

  Update Trigger

  This template updates an existing automation trigger using PUT /api/v2/triggers/{'{id}'}. Use this template to keep trigger configuration aligned with an external source of truth.

  • Each Nexset record must include the trigger identifier and the updated trigger payload expected by the Babelforce Triggers API.

Configure Manually

Babelforce destinations can be manually configured to send data to any valid Babelforce API endpoint — for example, endpoints not yet covered by the pre-built templates, or endpoints that require custom request bodies, headers, or batching.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Babelforce API after each call to a new Nexla webhook data source, making it easy to capture Babelforce-assigned IDs and downstream call status alongside the original Nexset data.

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 Babelforce API from the Method pulldown menu. Most Babelforce write endpoints accept:

   • POST: For creating new records (the typical choice for create-style endpoints such as /api/v2/outbound/lists or /api/v2/sms)
   • PUT: For updating existing records by ID (used by endpoints such as /api/v2/outbound/campaigns/{'{id}'})
   • DELETE: For removing records

Data Format

3. Select the format in which the Nexset data will be sent to the Babelforce API from the Content Format pulldown menu. Babelforce APIs are JSON-based, so application/json is the appropriate choice for almost all endpoints.

API Endpoint URL

4. Enter the URL of the Babelforce 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 the full API path — for example, https://services.babelforce.com/api/v2/outbound/lists. For update or upsert operations, include the ID of the object to be updated at the end of the URL (for example, https://services.babelforce.com/api/v2/outbound/campaigns/12345).

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). For Babelforce, additional headers are rarely required because authentication and content type are handled through the credential.

  You do not need to include the X-Auth-Access-Id or X-Auth-Access-Token headers here. These are automatically attached by Nexla based on your credential configuration.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this Babelforce destination, select the attributes from the Exclude Attributes pulldown menu. This is useful for stripping internal Nexla bookkeeping fields, identifiers that Babelforce assigns itself, or any sensitive fields that should not be transmitted.

• 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. Batching is typically used with Babelforce endpoints that accept an array of records — for example, bulk lead loading — and is left disabled for endpoints that require a single record per request.

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 Babelforce API after each call to a new Nexla webhook data source. This is particularly useful for Babelforce write endpoints, because the response typically contains the Babelforce-assigned identifier (for example, the new lead ID, campaign ID, or call ID) along with status information that downstream flows may need to capture.

• 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 Babelforce 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 Babelforce 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 Babelforce 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 the configured Babelforce endpoint, open the destination resource menu, and select Activate.

  The Nexset data will not be sent to Babelforce until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.