Mongoose Web Service Query
Original documentation from Cadence (requires login): https://help.mongooseresearch.com/article/598-send-to-slate-query
Send to Slate Query
Overview
Messages can be sent from Cadence to contacts that are in queries that exist within Slate. This can be helpful if you have a Query in Slate that encompasses a set of contacts you are looking to text without having to create a segment in Cadence. For this feature, a Cadence administrator must set up which queries are available for Cadence users to send to.
Note: The Slate integration must be configured before you can set up sending to Slate queries.
Connecting Cadence to your Slate Queries
Cadence utilizes the Slate web services to be able to connect to your Slate queries. This process is slightly different than how the Slate integration is connected for bringing contact data in from Slate as that utilizes the Slate SFTP. Authentication is required for web services so for that reason, you’ll see a separate configuration area called “Slate Queries” within your team drop down specific to setting up this feature. This area will need to be configured before your Slate queries show up within the “Compose” modal.
On the left side navigation, click on “Team Name”> Slate Queries
The overview section will provide a link to Slate documentation providing information on how to make sure your Slate Query is accessible via web services. ****Part of this process will require you to “Add Grantee” to the query for Cadence to access it. A username and password will be created during this process and this is the username and password required for us to authenticate.
Please note that this username and password is different than the service account being used for importing contact data.
To set up your Queries to have web services access and to “Add Grantee”, please reference this Slate documentation for more detailed information.
- Select Queries / Reports on the navigation bar.
- Select New Query and configure your query appropriately.
- Select Edit Web Service in the right-side pane.
- We do not require custom parametersSelect JSON as the service type.Parameter Settings: this will just be the information in the query url. You do not have to do anything here.
- Authentication: Slate provides two ways to set up authentication-User Token and Username. Please follow the steps for username.
- Select Edit Permissions in the right-side pane and Add Grantee to set it up.
- Ensure the Web Service checkbox is checked.
- The username and password for the Grantee will be the username and password needed in Cadence.
- A few things to note about the Grantee:
- You will need to add this grantee to each Query you’d like to send to.
- The Grantee is not tied to a specific user. It is not the same as the service account.
https://d33v4339jhl8k0.cloudfront.net/docs/assets/57d16d86c697914ce32d8b4b/images/65cd1f131359983245253b9e/file-M9n0BkVhmz.png
Enter the username and password here and click “
Save
“
https://d33v4339jhl8k0.cloudfront.net/docs/assets/57d16d86c697914ce32d8b4b/images/65cd1f4d1409b478491f5f99/file-wFSH1Hxkcc.png
After saving the username and password, you will see a “Queries” section to add the queries you would like to send text messages to. There is not a limit to how many queries you can add however, please note you will need to add each query you would like to have available for sending.
When selecting which Queries you would like to add, ensure at minimum the query contains the 4 standard/required Cadence fields that you have mapped to contactID, first name, last name and mobile number for the Slate integration (on the import configuration page). By default, Cadence will look for the fields you have mapped on the query. If we do not find those fields on your query,
To add a query, enter a name (it will be a display name within Cadence and should be clear for your users to identify the correct query-it does not have to match the name in Slate) and the service endpoint url.
To locate the Service endpoint, navigate to the Edit Query page>Identify the Web Services link (where it says JSON). Click the JSON to view the appropriate service endpoint.
Select the service account to see the URL for your Query. Copy and paste this URL into Cadence.
Note that Slate will require you follow this process to add the grantee to each query you’d like to use with Cadence.
Sending to a Slate Query
If you are in a team within Cadence that is integrated with Slate, you will find a tab for ” Send to Slate Query” when composing a message:
Sending Messages
When sending messages to a Query, the process is slightly different than sending to a regular list of recipients or segments.
The exact contacts that will receive the message is not known until Cadence begins the sending process. We do, however, know the total number of contacts on the Query, which is the largest possible group that the message could be sent to.
The confirmation step will show the total number of contacts in the Query along with an estimation for that number. Please make sure the number of contacts in your queries makes sense with the amount of time to send. Cadence will provide a delivery duration so you know how long it will take to send to all contacts in the query.
Who will receive messages?
- Only contacts that already exist within Cadence and are opted in will receive the message.
- If a contact exists in the Query, but not in Cadence, they will be skipped and not receive the message.
- If a contact exists in both the Query and in Cadence, but is opted out within Cadence, they will be skipped and not receive the message.
- If scheduling a message for a future date with the “Send to Slate Query” feature, please be aware that the message will send to contacts in the Query based the message goes to send.
at the time
- If you are sending with Send as assigned user enabled, the text will come from each contact’s assigned user in Cadence (assigned user settings are based on what field you have mapped to Staff Identification in your current Contact Import configuration). Contacts without an assigned user will receive the text from you/your texting number.
An email will be sent to the message sender indicating that sending is in progress for the Query and it will contain an attachment for any skipped contacts showing the reason they were skipped.