This guide will walk you through an example of integrating webhooks in your organization. These webhooks can be configured to perform a number of different jobs depending on your needs. This example will show how order notifications can be sent through email using Zaiper automated workflows.
Click the Organization button on the left hand navigation menu
From the Organization options click the Advanced button on the top menu
Click the Add Client button to add a new API Client
Set a name for the client and the site within your organization you want to configure
Choose the account type option(s) and click save
Choose any web integration software you like, for this example we'll use Zapier
Click the create button and choose Zaps
Choose the trigger option to start the workflow
Choose the Webhooks option
Choose the event you want this workflow to capture
For this flow we will choose a catch hook
Click the Test button
A URL will be generated automatically that we'll use to complete the workflow in the OMS Dashboard. Copy this URL
Navigate back to your OMS dashboard organizational view. Click the add webhook button
Create a name for your webhook and input the URL that was copied from Zapier into the Endpoint box
Choose any number of order status you want this event to trigger. For this example. we'll select all order status options. Click save to finish.
Click the orders button from the left hand navigation menu.
Choose an order from the list to test
This will test the order status change connection. This status change was selected in the webhook setup menu previously, we will capture anytime an order changes status and alert the user.
Click confirm to change order status
Click on the test trigger button to display the records for this order
We can see three records have been found. This reflects each time the order has changed status as well as the order information.
We will now setup the email notifications for this workflow. Choose the Action button
Choose your email of choice for this integration. For this example we'll select Gmail
Click the action event to select how you want this trigger to notify the user.
We'll select the Send Email option.
You can connect your Gmail account here.
Click on Continue to add the configuration parameters.
This is where you would enter the email of the recipient(s)
You can add any text here for the Subject of the email, you can also click the + button to add prefilled options.
You can add any text here for the Body of the email, you can also click the + button to add prefilled options.
Here you can see we added simple text to the Subject as well as a prefilled Order Number.
We have also added all the order information in the body of the email.
Click Continue to Test the connection
Click on test to test the connection
This shows all the information previously configured that will be sent to the recipient's email.
Navigate to your Gmail account and see the email with all included order information
Comments
0 comments
Please sign in to leave a comment.