Spotler

You can configure your PeopleStage and Orbit channels to make use of the integration with the Spotler broadcaster.

Prerequisites

Before you can make use of the Spotler integration, a few prerequisites must be met:

• Apteco software version

  Ensure you're using the latest Q4 2024 Apteco Suite. Upgrade your FastStats32Service and ensure the PeopleStage client matches this version by updating the Binaries. See Apteco Help Hub Software Update Guide.

• Spotler account and API key

  Obtain a Spotler Connect account and API key (password) (referred to as spotler_api_key) from Spotler. This gives you API access to a specific campaign account in Spotler. You need this to configure the Spotler channel and your Spotler account manager can provide this for you.

PeopleStage channel configuration

To configure your PeopleStage channel:

1. Go to the PeopleStage channel editor. Click File > Administration > Channel Editor.

   

2. Create a new channel.

3. Input the following settings in the Output Settings tab:

   • Response Key File Type: Urn with Broadcast Id

   • Broadcaster: Spotler

   • Username: A username should be specified but isn’t used in this case

   • Password: This needs to be your spotler_api_key

   • Message Content Type: Broadcaster Template

   • Retrieve existing message names: please tick this box

   

4. Set the following in the Parameter Settings tab:

   API Logger Path to track requests and responses for debugging:

   • API Logger Path: c:\temp\Spotler\Spotler_{yyyyMMdd}@{HHmm}.txt (Recommended to track requests and responses to Spotler)

   • Use Dated List: true

   • URL: https://app.spotlerconnect.com (URL target for Spotler Connect API requests)

   

Orbit channel configuration

To configure your channel:

1. Go into the Orbit channel editor.

2. Click User avatar > Application Settings > Campaigning Channel Editor.

3. Click + Item to create a new channel.

   

4. Input the following settings in Basic Details:

   • Response Key File Type: Urn with Broadcast Id

   • Broadcaster: Spotler

   • Username: A username should be specified but isn’t used in this case

   • Password: This needs to be your spotler_api_key

   • Email Variable: Click in the box and choose the variable containing the Email Addresses

   • Email Variable Description Override: Email

   • Reply Email Address: Add the required reply address to use in the emails that are sent

   

5. Set the following in Parameters:

   • Use Dated List: Tick the box

   • URL: https://app.spotlerconnect.com (URL target for Spotler Connect API requests)

   • API Logger Path: c:\temp\Spotler\Spotler_{yyyyMMdd}@{HHmm}.txt (Recommended to track requests and responses to Spotler)

   

   

6. Input the following settings in Output Settings:

   • Response Key File Type: Urn with Broadcast Id

   • Message Content Type: Broadcaster Template

   • Retrieve existing message names: please tick this box.

   

Template and database field setup

You can design your email content in Spotler MailPro:

• Database fields

  • Use fields like Firstname, Lastname, or DateOfBirth for static data that is held on the Contact record.

    Reference them in templates using {{ contact.fieldname }}. Example: {{ contact.Firstname }}

  • Apteco will substitute spaces for underscores in field names which is seen when specifying these fields within email templates. (e.g., Phone number → Phone_number).

• Dynamic fields (DMD fields)

  • Use these for values that change per send, e.g., discounts or transactional data.

  • Reference format: {{ contact.DMD_fieldname }}. Example: {{ contact.DMD_discount }}

Note: Please refer to Spotler documentation for template configuration.

Spotler campaigns

You can configure deliveries to use your Spotler MailPro templates and manage recipient data.

To configure your deliveries:

1. Choose an email template from the drop-down list within your message step.

2. Specify a group name for the delivery.

   Note: Groups are automatically created with a unique datetime suffix for each send.

3. Define your content either in the channel or at the content step.

4. Use DMD_ prefixed fields for transactional data (e.g., DMD_discount), sent during email trigger without updating Spotler's database.

5. Use non-DMD_ fields such as contact.Firstname for persistent data across communications for the same recipient.

When the campaign is published:

• A new group is created

• Selected recipients are added to the group

• The email template is triggered for each recipient in the group

PeopleStage Example: We are uploading Firstname to a database field, and my discount is sent without updating the database at the time it's sent.

Collecting responses

To start collecting responses:

1. Download the DigitalIntegrations.zip file from the Apteco Portal and install the FastStats Email Response Gatherer (FERG).

   

   Important: If you are using an earlier Apteco software version than Q4 24, then it won’t have Spotler as an option in the Broadcaster dropdown window.

2. Run the FastStats Email Response Gatherer Configurator.

   • Connection String: Make sure that this is pointing at your response, RS_ database

   • Broadcaster: Drop down and select Spotler

   • Username: The username needs to be specified here, but it isn’t used to connect in this case

   • Password: The password field needs to contain the spotler_api_key

   • SMTP Properties: Add your email server details and tick the 'Send Email on Error' tickbox to be notified

   • Broadcast Parameters: Use the dropdown to choose each of the Parameters to enter in turn

   • RESPONSEPERIOD: 3M

     Note: M is related to Months. The download in this case would be a rolling 3 month period.

   • URL: https://app.spotlerconnect.com

   

Example FERG configuration

<EmailResponseGathererConfiguration xmlns:xsd="<http://www.w3.org/2001/XMLSchema>" xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>">
  <ConnectionString>Your connection string to the RS_ database</ConnectionString>
  <ConnectionTimeout>1200</ConnectionTimeout>
  <BulkInsertDirectory>c:\\Temp\\BulkInsert</BulkInsertDirectory>
  <BroadcasterName>Spotler</BroadcasterName>
  <Username>username</Username>
  <Password>spotler_api_key</Password>
  <SendEmailOnError>True</SendEmailOnError>
  <Parameters>
    <Parameter>
      <Key>URL</Key>
      <Value><https://app.spotlerconnect.com></Value>
    </Parameter>
    <Parameter>
      <Key>ResponsePeriod</Key>
      <Value>3M</Value>
    </Parameter>
  </Parameters>
  <SmtpSettings>
    <Port>25</Port>
    <Server>exchange.apteco.com</Server>
    <SSL>False</SSL>
    <Username />
    <Password />
    <From>from email</From>
    <To>to email</To>
  </SmtpSettings>
</EmailResponseGathererConfiguration>

Notes

• Spotler updates response files once daily. Coordinate with Spotler to determine the update schedule.

• Responses include metrics such as email opens, clicks, and bounces.

• For any issues or advanced configurations, refer to Spotler's documentation or contact Apteco Support.

• Always ensure your Spotler account details and API key are securely stored.