https://github.com/zendesk/sunshine-conversations-api-quickstart-example
Sample code to get started with the Sunshine Conversations REST APIs
https://github.com/zendesk/sunshine-conversations-api-quickstart-example
Last synced: about 1 year ago
JSON representation
Sample code to get started with the Sunshine Conversations REST APIs
- Host: GitHub
- URL: https://github.com/zendesk/sunshine-conversations-api-quickstart-example
- Owner: zendesk
- License: apache-2.0
- Created: 2016-12-01T18:59:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T16:53:30.000Z (over 1 year ago)
- Last Synced: 2025-03-25T16:55:13.370Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 151 KB
- Stars: 18
- Watchers: 223
- Forks: 25
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sunshine Conversations API Examples
## Get started
For a detailed guide, see the [Sunshine Conversations API Quickstart](https://developer.zendesk.com/documentation/conversations/getting-started/api-quickstart/):
### Node.js
1. Clone the repository
2. Go to the _nodejs_ subdirectory
3. Install dependencies (`npm install`)
4. Use [ngrok](https://ngrok.com/) to create a secure tunnel to port 8000 (`ngrok http 8000` after ngrok is installed on your PC)
5. Create a webhook and API key in Admin Center and point it at the full url for the `/messages` endpoint (e.g. `https://MY-NGROK-DOMAIN.ngrok.io/messages`)
6. Update `index.js` to set proper values for `ZENDESK_SUBDOMAIN`, `KEY_ID` and `KEY_SECRET`
7. Run the server (`node index`)
8. Send messages to your Web Widget and watch the auto-replies roll in