Skip to main content

CallRail 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 CallRail location.
call_rail_api.png

CallRail

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

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

  3. CallRail destinations can be manually configured to send data to any valid CallRail API v3 endpoint. Common write operations include creating outbound calls, sending text messages, creating companies, and submitting custom data via the CallRail API. You can also configure Nexla to automatically send the response received from the CallRail API after each call to a new Nexla webhook data source.

    First, select the API method that will be used for calls to the CallRail API from the Method pulldown menu. Common methods for CallRail write operations:

    • POST: For creating new records (e.g., creating a company, sending an outbound call, submitting a form)
    • PUT: For fully replacing an existing record (e.g., updating a company's full configuration)
    • PATCH: For partially updating an existing record (e.g., updating specific fields on a tracker or company)
    • DELETE: For removing records from your CallRail account

Data Format​

  1. Select the format in which the Nexset data will be sent to the CallRail API from the Content Format pulldown menu. The CallRail API v3 accepts and returns data in JSON format; select JSON as the content format so Nexla will automatically serialize the Nexset records into JSON for each API call.

API Endpoint URL​

  1. Enter the URL of the CallRail API v3 endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://). For update or delete operations, include the ID of the object to be updated at the end of the URL path.

    Common CallRail write endpoints include:

    • Create a company: https://api.callrail.com/v3/a/{'{account_id}'}/companies.json (POST)
    • Update a company: https://api.callrail.com/v3/a/{'{account_id}'}/companies/{'{company_id}'}.json (PUT/PATCH)
    • Create a tracker: https://api.callrail.com/v3/a/{'{account_id}'}/trackers.json (POST)
    • Update a tracker: https://api.callrail.com/v3/a/{'{account_id}'}/trackers/{'{tracker_id}'}.json (PUT/PATCH)
    • Send an outbound call: https://api.callrail.com/v3/a/{'{account_id}'}/calls.json (POST)
    • Send a text message: https://api.callrail.com/v3/a/{'{account_id}'}/text-messages.json (POST)

    Replace {'{account_id}'}, {'{company_id}'}, and {'{tracker_id}'} with the corresponding identifiers from your CallRail account. Account IDs can be retrieved via the /v3/a.json endpoint.

For complete details on required and optional request body parameters for each CallRail write endpoint, refer to the CallRail API v3 documentation. Ensure that the field names in your Nexset match the expected parameter names in the CallRail API request body.

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 the Authorization header — Nexla automatically adds the authentication token from your saved credential to every request sent to the CallRail API.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this CallRail destination, select the attributes from the Exclude Attributes pulldown menu. This is useful when your Nexset contains internal tracking fields or metadata that should not be sent to the CallRail API.

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

Response Webhook​

Optional

Nexla can automatically send the response received from the CallRail 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 company or tracker.

  • 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 CallRail 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​

After all endpoint settings have been configured, Nexla can send a test payload to the CallRail 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 CallRail 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 CallRail endpoint, open the destination resource menu, and select Activate.

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