Connecting Genius Chat to Sunco (V1)
This is for version 1 of chat only.
DigitalGenius Chat integrates with with Sunshine Conversations, allowing end users to speak to agents on Zendesk.
In order to setup a connection between DG chat and Sunco please follow these steps:
Step 1. Create the connection on DigitalGenius dashboard
From your DigitalGenius dashboard go to Modules section and click on the Sunshine Conversations module. Click on Add Connection.
Provide a name for your new connection and click on the Connect button.
Next, you will need to specify your Zendesk subdomain and sign in.
Step 2. Authorize and test the new Sunshine Conversations connection
You will be asked to authorize the connection. After confirming it, you will be redirected back to the Sunshine Conversations Modules page where you can test your new DigitalGenius connection to Sunshine Conversations.
Click on Allow
If everything was set up correctly you should see a green check mark.
Step 3. Sunshine Conversations Integration Webhook
The URL for the webhook target is one from the below options based on your region.
You can copy the flow id from the Flow Builder UI.
EU: https://flow-server.eu.dgdeepai.com/sunshine/{{flow_id}}/append-messages-webhook
US: https://flow-server.us.dgdeepai.com/sunshine/{{flow_id}}/append-messages-webhook
QA: https://flow-server.qa.us.dgdeepai.com/sunshine/{{flow_id}}/append-messages-webhook
DEV: https://flow-server.dev.us.dgdeepai.com/sunshine/{{flow_id}}/append-messages-webhook
Use the webhook URL in order to create a new Sunshine Conversations integration:
Click save and then copy the Shared secret value in the following popup for use later in step 8 of this guide:
Step 4. Setup connection with Sunco api
Go to APIs -> Conversations API in Sunco api:
Click on the Create API key
button and give your key a name and then click on Next
Copy the App ID
, Key ID
and Secret key
values and copy them in to the DigitalGenius postman collection environment variables in the Sunco section (if you have the latest version of Postman you can use the filter at the top of the env variables modal to filter by sunco
):
Put the App ID
value in to the sunco_app_id
field
Put the Key ID
value in to the sunco_api_key_id
field
Put the Secret key
value in to the sunco_api_key_secret
field
Click on the Save
button
Go back to the Sunco admin and click on the Next
button.
Step 5: Create Sunco bot
Got to Channels -> Bots in the Sunco UI and click on connect for the DigitalGenius bot
Step 6. Configure the Sunco api
Go to Postman and in to the Genius Flow API collection -> Integrations -> Sunshine Conversations -> SunCo Setup
Execute the GET List Switchboards
endpoint and copy the id
property from the response.
Paste that id in to environment variables in the sunco_switchboard_id
field
Click on Save
to save the environment variables
Go back to Genius Flow API collection -> Integrations -> Sunshine Conversations -> SunCo Setup
and execute the GET Get Switchboard Integrations
endpoint
Copy the id
value from the DigitalGenius
integration
Go to Genius Flow API collection -> Integrations -> Sunshine Conversations -> Obselete
and select the PATCH Update Switchboard Integration
endpoint and paste the id from the previous step in to the postman url bar to replace the sunco_switchboard_integration_id
placeholder:
Next go to the Body tab in Postman and set the body to be
{
"deliverStandbyEvents": true
}
Click on the Send
button.
Step 7. Configure the Chat Widget
Finally you need to configure the chat widget. The config should look like so:
crm: {
handover: true,
platform: 'sunco',
connectionId: '4fede158-f57e-45ae-aa69-7a41bacf8c88',
switchboardIntegrationId: '647d802a53ebeaf53ed4d7bh',
appId: '647d8029137db9ba3d769c33',
}
The connectionId
can be taken by clicking in the i
icon on the connection that was created in step 2:
The App Id
can be taken from step 4
The switchboardIntegrationId
can be taken by running executing the GET Get Switchboard Integrations
endpoint and taking the id
property from object that has a name
property with the value of zd-agentworkspace
:
Step 8: Patch the Flow External Account Key with the Sunco secret
Take the Shared secret key you received in step 3 and set that to be the external key for the master flow (and any other related flows - i.e. csat or aux):
Set the External Account Key
field to be the Sunco secret and set the External Integration
field to be:
{
"name": "zendesk_chat_conversations"
}
Click Submit
to save the change.
Updated about 1 month ago