https://github.com/uniquelyparticular/sync-shipengine-to-zendesk
This Particular example demonstrates how you can sync shipping status from ShipEngine into Zendesk Sunshine via Webhook API.
https://github.com/uniquelyparticular/sync-shipengine-to-zendesk
crm ecommerce integration microservices particular shipengine shipping sunshine webhooks zendesk
Last synced: 3 months ago
JSON representation
This Particular example demonstrates how you can sync shipping status from ShipEngine into Zendesk Sunshine via Webhook API.
- Host: GitHub
- URL: https://github.com/uniquelyparticular/sync-shipengine-to-zendesk
- Owner: uniquelyparticular
- License: mit
- Created: 2019-04-12T17:11:47.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2026-02-02T15:06:50.000Z (4 months ago)
- Last Synced: 2026-02-03T03:57:57.426Z (4 months ago)
- Topics: crm, ecommerce, integration, microservices, particular, shipengine, shipping, sunshine, webhooks, zendesk
- Language: JavaScript
- Homepage: https://uniquelyparticular.com
- Size: 398 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 97
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @particular./sync-shipengine-to-zendesk
[](https://www.npmjs.com/package/@particular./sync-shipengine-to-zendesk) [](https://github.com/semantic-release/semantic-release) [](https://github.com/prettier/prettier) [](https://circleci.com/gh/uniquelyparticular/sync-shipengine-to-zendesk)
> Add a Zendesk Sunshine Event whenever a Shipping Status change is triggered in ShipEngine
Asynchronous microservice that is triggered by [ShipEngine](https://www.shipengine.com/) webhooks to create a Sunshine Event inside of [Zendesk](https://zendesk.com).
Built with [Micro](https://github.com/zeit/micro)! 🤩
## 🛠 Setup
Both a [Zendesk](https://zendesk.com) _and_ [ShipEngine](https://www.shipengine.com/) account are needed for this to function.
Create a `.env` at the project root with the following credentials:
```dosini
ZENDESK_SUBDOMAIN=
ZENDESK_INTEGRATION_EMAIL=
ZENDESK_INTEGRATION_SECRET=
```
`ZENDESK_SUBDOMAIN` is the first part of the URL for your Zendesk account (ie. https://{ZENDESK_SUBDOMAIN}.zendesk.com/).
While logged in to your Zendesk instance create a new User to run the Webhooks under by going to `Settings` > `People` > `Add User` > `Role: Staff`; this email address will be used as your `ZENDESK_INTEGRATION_EMAIL` above.
Find your `ZENDESK_INTEGRATION_SECRET` within your Zendesk instance by going to `Settings` > `API` > enable `Token Access` > add `Active API Tokens [+]` > `API Token`.
## 📦 Package
Run the following command to build the app
```bash
yarn install
```
Start the development server
```bash
yarn dev
```
The server will typically start on PORT `3000`, if not, make a note for the next step.
Start ngrok (change ngrok port below from 3000 if yarn dev deployed locally on different port above)
```bash
ngrok http 3000
```
Make a note of the https `ngrok URL` provided.
## ⛽️ Usage
Next head over to the ShipEngine [API Management>Webhooks](https://app.shipengine.com/#/portal/apimanagement) area, add a new webhook with the following details:
| Events | Webhook URL | Status |
| ------------------ | ------------------- | ------ |
| Any tracking event | `ngrok URL` above\_ | On |
## 🚀 Deploy
You can easily deploy this function to [now](https://now.sh).
_Contact [Adam Grohs](https://www.linkedin.com/in/adamgrohs/) @ [Particular.](https://uniquelyparticular.com) for any questions._