Prokeep Eclipse SMS Integration Setup Instructions

Overview & Requirements

The Eclipse Order Notification Trigger integration allows Eclipse to automatically send SMS messages to customers through Prokeep when supported order events occur. This integration is built and maintained by Epicor and uses the Prokeep Messaging API to deliver outbound SMS notifications.

Before configuring the integration, ensure the following requirements are met:

• Your Prokeep account must be on Prokeep Plus to use the Messaging API.

• Your Eclipse environment must be enabled for the Prokeep SMS trigger by your Epicor Eclipse representative.

• Eclipse version 22.1 (May 2022) or later is required, with Solar Eclipse APIs enabled.

---

Known Limitation

All SMS messages sent through the Eclipse trigger will have the Eclipse Order ID automatically appended to the end of the message. This behavior cannot be changed through standard configuration.

Example:
If your SMS template is configured as:

Eclipse Updates: Thanks for shopping with us. Here are your order details

The message sent to the customer will be:

Eclipse Updates: Thanks for shopping with us. Here are your order details Order ID: S103927442

It may be possible to modify this behavior or append additional values through custom programming; however, this would require consultation with Epicor’s team and is not supported as part of the standard integration setup.

---

Getting Started

In Prokeep: 

1. Navigate to Settings > API > Generate Application. 
2. Name the application “Eclipse Order Notifications” or something similar.  
3. Click “Generate Credentials.” 
4. Store the Credentials somewhere you can access them later like a notepad. 
5. Click “Confirm”

In Eclipse:  

1. Verify you are on the updated version of the May 2022 release or later.  

`2. If you’ve not done so already, work with your Epicor rep to enable the Prokeep SMS Trigger on your account. 

3. Navigate to System> System Programming > Add On Products> API Maintenance> API  Configurations. Select “Prokeep Service”. Click on the “Global Settings” Tab.  
4. Input your Prokeep URL into the “URL” field under “Connection Settings”. For example https://testcompany.prokeep.com

5. Copy and paste the credentials from Prokeep to the Username and Password fields in Global  Settings.  

6. Click Create Trigger Activity

7. Under Branch Settings, set up the numbers that each branch will be texting from. You can ask your CSM for a list of Group Phone Numbers if you need clarification on which groups use which numbers. 

Important: Phone numbers in Eclipse must be entered as a continuous 10-digit number with no spaces, parentheses, or dashes.

• ✅ Correct: 7777777777

• ❌ Common incorrect formats:

  • (777) 777-7777

  • 777-777-7777

  • 777 777 7777

  • +1 (777) 777-7777

8. Now that the trigger is enabled, you can set up Prokeep messages for any Activity  Triggers in Eclipse by selecting “Prokeep SMS” when configuring the trigger. 

 

9. Once the trigger is set, you can customize the message by clicking SMS. If you would like  Eclipse to send the message to the number tied to the order contact, Select Auto in the “To”  field.  

---

Examples: 

Here is an example of what the message looks like from each side of the conversation. 

Contractor View:

Prokeep User View: 

---

Opt-Outs for Automated vs. Conversational Messages

Customers can manage message preferences separately:

• Conversational messages: Reply STOP to opt out.

• Automated messages (via Eclipse): Reply X to opt out.

This allows customers to stop automated texts while still receiving direct messages from your branch.

---

Note: 

• Outbound text messages sent programmatically via our API will be billed on a monthly basis, at $0.01 per SMS and $0.03 per MMS. Customers with API usage are required to provide an electronic payment method to account for monthly API messaging payments.
• All messages related to orders will be appended with the Order ID to provide context to the contact. 
• The integration uses the shipping branch by default but can be modified to use the pricing branch. 
• An error will occur if a contact does not have a valid mobile number on their contact record.
• Most of our customers are using the following triggers: 
  • Order Confirmation
  • Order out for Delivery
  • Order Ready for Pick Up