Sinch Account Onboarding (new Sinch customers)

  • Updated

SINCH ONBOARDING

Sinch account setup needed to begin using Sinch solutions via Sureshot (Eloqua, Responsys or Connect)

OVERVIEW & PURPOSE

Before customers are able to use any of the Sureshot solutions that utilize Sinch, there are several steps that need to occur at the Sinch account level.

STEPS

  • Obtain Sinch sender number (short code or 10DLC)

Note that as of March 2023, Sureshot solutions allow for 1 static sender number per configuration / workflow

  • Enable the Conversation API for the Customer Sinch account (if the customer is using their own account)

The alternative is if we will be setting up the customer under the Sureshot account as a Subproject.

  • Enable SMS and MMS on the Conversation API
  • Generate Access Key for the customer account
  • Add Sureshot-provided webhook to Sinch Project / App 

DETAILS

Conversation API 

Setup of the Conversation API can be seen in the Sinch customer dashboard.  Once logged in, the user will see details under Conversation API > Overview.  Here, you can see the Project ID, App ID and which Channels have been enabled.

 

Generate Access Key

In the Sinch dashboard, the customer can generate Access Keys.  This information will be used by the Sureshot application to authenticate into the customer Sinch account for the purpose of sending messages through the Conversation API.

Go to Settings > Access Keys and click Create Key

Provide a name for the key (suggestion is to include “sureshot” in the name) and click Confirm.

You will be presented with a key and a secret that will need to be provided to Sureshot.

Note that if users are not comfortable sharing these details via email, support ticket, etc. we are able to send them directly to the Sureshot Credential Manager page and they can enter the values themselves.  To do this, the following steps should be done:

  1. Add the user to the Connect organization
    1. They will receive an invitation to join and need to accept the invitation and create a password.
  2. Send them this link: https://app.sureshot.io/credentials
  3. Have them login to this link using their email and the password they created
  4. Click the button
  5. Select Add Sinch Credential
  6. User should enter a Name (suggestion is to include their company name in the Name)
  7. Include their region (defaults to ‘us’)
  8. Enter the Key ID and Secret
  9. Save Credential and log out of Sureshot

Add Webhook to Sinch account (Sureshot team can help with this if needed)

Once Sureshot has configured the customer’s workflows, a webhook URL will be provided that needs to be added to the Sinch account.  To add this value, login to the Sinch dashboard and complete the following steps: 

  1. Under Conversation API > Overview, click on the Display Name of the app
  2. Scroll down to the section called Webhooks
  3. (Responsys and Connect only) Click Add Webhook 
    1. Leave Target Type as HTTP
    2. In Target URL, provide the webhook URL provided by Sureshot
    3. Leave Secret Token blank
    4. Select the following Triggers
      1. MESSAGE_DELIVERY
      2. MESSAGE_INBOUND
  4. (Eloqua v1 only) Click Add Webhook (Delivery)
    1. Leave Target Type as HTTP
    2. In Target URL, enter: https://app.incindio.com/api/config/incindio/sinch/webhook/message/delivery
    3. Leave Secret Token blank
    4. Select the following Trigger
      1. MESSAGE_DELIVERY
  5. (Eloqua v1 only) Click Add Webhook (Inbound)
    1. Leave Target Type as HTTP
    2. In Target URL, enter: https://app.incindio.com/api/config/incindio/sinch/webhook/message/incoming
    3. Leave Secret Token blank
    4. Select the following Trigger
      1. MESSAGE_INBOUND
    5. Leave oauth off
    6. Click Create

  1. Your saved webhook configuration should look like this:

OTHER (RESPONSYS ONLY)

  1. The Sureshot team will need to configure workflows to send the Sinch messages as well as receive the webhook messages.
  2. Current solutions:
    1. Responsys: utilizes Responsys Program and Scheduled Filters to trigger messages to a specified list of contacts.
    2. Connect: Source data can be webhooked to a Connect workflow, or data can be sourced from a CSV file and processed through Sinch using connectors.
      1. Keyword auto replies can be managed via separate Connect workflows that separate inbound messages by keyword and utilize a separate Sinch outbound connector to send the customized response.
    3. Eloqua ( delivery date 2Q2023): Eloqua campaigns can be used to send Sinch SMS or MMS messages and results can be written to a CDO.



Powered by Zendesk