Skip to content

Enreach Outbound – nps.today Integration Setup

Overview

There are three different ways to configure an automatic survey to be sent out via nps.today in Outbound:

  1. Via the trigger system (created specifically for each campaign)
  2. Via hooks in the API (created specifically for each campaign, but hidden in the UI)
  3. Via SmartHub (created in a script that can run on all, one, or multiple campaigns)

Prerequisites

  • An active nps.today subscription
  • An API key in your Outbound account (may require input from nps.today)
  • An active Outbound account

Setting Up via Triggers

With triggers, you can send data directly to nps.today to send out the specific survey you want.

Creating a Trigger

  1. Go to Campaign Overview, select your campaign, and click Edit.
  2. Select Triggers and click Add Trigger.

Create Trigger

Enter a name for your trigger, fill in the details, and add a conditional field if needed.

Set-up Trigger

Creating an HTTP Request Action

Final HTTP Request Action Example

Final HTTP Request Action example

  1. Under Action, select Create New Action.

  2. In the pop-up, enter the following information:

    Action type: Make an HTTP request
    Method: POST
    URL Template:

    https://api.nps.today/campaigns/{campaignId}/respondents
    Insert the campaignId for the nps.today campaign you want to send data to.

    If you don’t know your campaign ID, read this guide:
    How to find campaign ID

  3. Headers
    Add your API key in the headers:

    Content-Type: application/json
Authorization: apikey {insert your api key here}

    Header

    If you don’t have an API key or don’t know where to find it, read this guide:
    How to create an API key

  4. Content Template
    Add the data you want to send to nps.today.
    You can send as many fields from Outbound as you like. nps.today requires either a phone number (for SMS surveys) or an email address (for Email surveys).

If you want data returned to the lead in Outbound from nps.today, the unique ID of the Outbound lead is required.

Content Template Example 
```json
[
    \{
        "respondent": \{
            "emailAddress": "{lead.data.import name of email field}",
            "phoneNumber": "{lead.data.import name of telephone field}",
            "externalId": "{lead.uniqueid}"
        \}
    \}
]
```

Content template

For the email and/or phone number, copy the import name from your campaign template and insert it in place of import name of xxxxxx.

You can also add additional fields such as employee information.
For questions, please contact our support team.

Trigger Completed

Once complete, save your trigger action and trigger, and make sure the trigger is active.

Set-up Trigger

You're now ready to go!

Setting Up via Hooks

If you want to create your own integration between Outbound and nps.today, this can be done using our webservice API and hooks.

You’ll need: - An API user with the correct access.

Read more about creating a hook here:
Enreach Outbound API - Hooks

Example Hook Body 
{
  "name": "string",
  "isActive": "boolean",
  "campaignCode": "string",
  "leadReleaseType": "string",
  "leadStatus": "string",
  "leadClosure": "string",
  "method": "string",
  "headers": "string",
  "urlTemplate": "string",
  "contentTemplate": "string"
}

Field Descriptions:

  • name: The name of the hook
  • isActive: Defines whether the hook is active
  • campaignCode: Found via Campaigns API
    (Either the campaign uniqueId or the code can be used)
  • leadReleaseType: Optional. Supported types can be fetched here:
    GET hooks meta
  • leadStatus: Required. Supported types can be fetched here:
    GET hooks meta
  • leadClosure: Optional (NotSet, Success, NotInterested, InvalidLead, Unqualified)
  • method: POST
  • headers, urlTemplate, contentTemplate: Same as described in the trigger setup above.

For any questions, contact our support team.

Setting Up via SmartHub

This option requires the SmartHub add-on module.

SmartHub is a built-in scripting tool that provides more custom and flexible ways of handling leads.
With SmartHub, you can configure the nps.today survey trigger to activate only when specific conditions are met, for example:

  • Only if a certain amount of conversation time has been conducted
  • Only if specific lead field combinations are met
  • Only for specific campaigns
  • For all campaigns (centralized control)

We offer custom development of these scripts.
Please reach out to your Customer Success Manager or our Support Team with any questions.

Getting Data Back to Outbound

It is possible to send any data returned from nps.today back into any lead field in Outbound.

Feedback data on leads

Currently, this requires a custom setup by the Enreach Outbound development team.
Please contact your Customer Success Manager at Enreach Outbound or nps.today to discuss your specific needs.