StarRez Integration

Overview

StarRez integrates with Mongoose using the Mongoose API to trigger text messages directly from the StarRez platform.

This integration uses the CreateAndSend API endpoint to send outbound text messages from Mongoose.

Before You Begin

Before configuring the integration, make sure you have:

• API credentials created in Mongoose
• Access to the appropriate Mongoose team
• A valid Staff ID in Mongoose
• Access to the correct shared inbox (if using one)

How the Integration Works

StarRez sends message data to the Mongoose API using the following endpoint:

https://api.mongooseresearch.com/v2/messages/CreateAndSend

Clients configuring the integration in StarRez will typically need to provide a “Data Template.” This template contains values specific to your Mongoose instance.

Example Data Template

{
  "staffId": "janedoe",
  "groupAccountCode": "H",
  "departmentCode": "9999999",
  "messageContent": "{Body}",
  "mobileNumber": "{Number}"
}

Understanding the Data Template Fields

staffId

The staffId is the Mongoose Staff/User ID of the user sending the message.

This must match an active Mongoose user.

Example:

"staffId": "janedoe"

groupAccountCode

The groupAccountCode is the code for the shared inbox used to send messages.

You can find this value on the Shared Inbox page in Mongoose.

Example:

"groupAccountCode": "H"

departmentCode

The departmentCode is the team code associated with the API credentials created for the integration.

To locate this value:

1. In Mongoose, open the Team dropdown menu.
2. Select API.
3. Locate the Team Code/Department Code.

Example:

"departmentCode": "9999999"

messageContent

The messageContent field contains the body of the text message being sent.

Example:

"messageContent": "{Body}"

mobileNumber

The mobileNumber field contains the recipient’s mobile phone number.

Example:

"mobileNumber": "{Number}"

Important Notes

• StarRez currently supports outbound messaging only.
• Message replies, message activity, and opt-out statuses do not sync back into StarRez.
• If using a shared inbox, verify the Staff ID has permission to access that inbox.
• The departmentCode must match the team where the API credentials were created.

FAQs

Does StarRez sync message replies back into Mongoose?

Yes. Messages are sent through Mongoose, so replies will appear in Mongoose.

However, replies and message activity do not sync back into StarRez.

Where do I find the groupAccountCode?

You can find the shared inbox code on the Shared Inbox page in Mongoose.

Can I use a personal inbox instead of a shared inbox?

Yes. If you are not using a shared inbox, you may not need to include a groupAccountCode.

What happens if the Staff ID does not have access to the shared inbox?

Messages may fail to send properly. Make sure the Staff ID belongs to a user with access to the selected shared inbox.

Where do I find the departmentCode?

Navigate to:

Team Dropdown → API

The Team Code/Department Code is displayed there.

Troubleshooting

Messages are not sending

Verify the following:

• The API credentials are active
• The departmentCode is correct
• The staffId is valid
• The Staff ID has access to the shared inbox
• The recipient mobile number is properly formatted

Shared inbox messages are failing

Confirm the user tied to the staffId has permission to send messages from the selected shared inbox.