@particular./sync-shipengine-to-zendesk
v1.1.3
Published
Please contact Particular. via [email protected] for any questions
Downloads
4
Maintainers
Readme
@particular./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 webhooks to create a Sunshine Event inside of Zendesk.
Built with Micro! 🤩
🛠 Setup
Both a Zendesk and ShipEngine account are needed for this to function.
Create a .env
at the project root with the following credentials:
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
yarn install
Start the development server
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)
ngrok http 3000
Make a note of the https ngrok URL
provided.
⛽️ Usage
Next head over to the ShipEngine API Management>Webhooks 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.
Contact Adam Grohs @ Particular. for any questions.