RD Station: Export data via REST API

This document provides step-by-step instructions to set up and start leveraging a RD Station integration.

Ion integrates seamlessly with RD Station via their REST API. Ion's RD Station integration enables you to add contacts to RD Station in real time. 

Before we begin

There are a few items you'll need to roundup from RD Station prior to setting up the integration, listed below:

A private app needs to be created in RD Station in order to generate the REST API details. 

  • RD Station Client ID
  • RD Station Client Secret

Please find steps below to generate these details within RD Station. Should you need additional guidance with the steps below, please reach out to RD Station support.

  1. Log into RD Station App Store

  2. Click “Create App” button

  3. Give your app a name, select a category, and check the boxes for the languages you would like to support.

  4. For the callback URL, use the below, but replace the bold part of the URL with your Ion console’s URL. Please note that the actual client ID value will replace the xxxxx placeholder in step 8.

    1. https://yourcompany.postclickmarketing.com/Admin/Integration/RDStationAccounts/HandleCallback?clientid=xxxxx

  5. Click “Save and next” button

  6. The next screen will show you your app’s Client ID, Client Secret and the Callback URL. Copy both the Client ID and Client Secret values from this screen and save them in a separate document for later.

  7. Click next
  8. Edit your app’s information and replace the placeholder clientID value (xxxxx) with the Client ID value that you copied.

  9. Save

There are a few items you'll need to have ready in Ion prior to setting up the integration, listed below:

Check out the "Before you begin" support post for guidance in creating these items.

  • Create data collection fields
  • Create ion form(s)
  • Set-up testing creative

Let’s Get Started!

1. Add RD Station account credentials to Ion

  1. Click the Integrations tab in your Ion console’s side nav
  2. Click “Set up account credentials” toward the top of the screen
  3. Under "RD Station", click “New RD Station credential”
  4. Add a friendly label for your account, then enter your RD Station Client ID and RD Station Secret
  5. Save

2. Create field mapping

Taking the steps below will map your Ion data collection fields to their corresponding RD Station API field names. To get started, add a new field mapping:

  1. Navigate into the Integrations screen
  2. Click green “New field mapping” button
  3. Label the field mapping and optionally add a description
  4. From the Integration type menu, select “RD Station”
  5. Save

3. Add Outbound fields to field mapping

Outbound fields define the data you extend from Ion to RD Station.

  1. Click green “New outbound field” button
  2. Add a field by selecting the field type from the source dropdown
    • To add a form field, hidden field or query string variable, select “Data field” and pick the data field category then data collection field
    • OR, to add an Ion Core field, select Core Field then pick the field you seek to include
    • OR, to export multiple Ion fields to one external field, pick Mashup and plug  {{DataName1}} {{DataName2}}, etc. into the editor
    • OR, to reformat a value prior to export, pick Javascript code and add logic around the value collected in Ion. To access data collection fields via Javascript, use respondent.dataname.
  3. Optionally make your field required to run the integration
  4. Optionally add a default value
  5. Select the RD Station field from the drop-down menu of your RD Station API field names
  6. Save
  7. Repeat these steps for each field that should be included in the Field Mapping
  8. Skip adding Inbound fields

*IMPORTANT: RD Station requires an email address to be included for the integration to be successful. Please make sure you include an email address field in your field mapping to meet this RD Station requirement. 

4. Create integration

  1. Navigate back to your Integrations screen
  2. Click into the Integrations tab
  3. Click green “New integration” button
  4. Enter label
  5. Optionally add a description
  6. Select the Field Mapping you’ve just created
  7. Set maximum retries
    • If there is a service interruption with the external platform, Ion will retry the post on the top of the hour for as many retries as you indicate here.
  8. Select Add Lead as the API method
  9. Optionally add yourself to the debug distribution list for testing
    • This will deliver an email to the designated address when the integration runs that displays the request and response from RD Station

5. Add integration to Ion pages

The Ion platform runs the integration based on rules you create. Rules can be added to any actionable item in your Ion creative. Integration rules are typically run at the form-level, upon form submission, or on an assessment step. Follow the steps below to add the integration to your Ion pages.

  1. Navigate into the creative
  2. Click on the form, button or link you seek to make the trigger to run your integration
  3. In Creative Studio, click on +rules
  4. Select the condition that needs to be met to run the integration
    • “No conditions required” is typically used
  5. Select “Run integration” then select your RD Station integration as the action
  6. Save

6. Test integration

To test your integration, use the creative you set up prior to beginning the integration steps. Please note, integrations do not run in Preview Mode so you'll want to open a URL for testing. The integration will run once you submit the Ion form, or complete the action that runs the integration rule. If you’re on the debug email distribution list, you’ll receive an email that displays the data you transferred and response from RD Station. You’ll also want to verify success by ensuring the lead was created in your RD Station instance.

Nice work!

Once you’ve completed these steps, your integration is ready for use. You can add the rule to run the integration on all applicable creatives. 

If you have any questions, please contact us at help@rockcontent.com. 😀