Add a Zendesk Sunshine Event whenever a Shipping Status change is triggered in Shippo
Asynchronous microservice that is triggered by Shippo webhooks to create a Sunshine Event inside of Zendesk.
Built with Micro! 🤩
Both a Zendesk and Shippo 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.
Run the following command to build the app
yarn installStart the development server
yarn devThe 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 3000Make a note of the https ngrok URL provided.
Next head over to the Shippo API Settings area, add a new webhook with the following details:
| Event Type | Mode | URL |
|---|---|---|
| Track Updated | Test |
ngrok URL above |
You can easily deploy this function to now.
Contact Adam Grohs @ Particular. for any questions.