This article lists down the steps to create and manage webhooks in Carriyo.
Webhooks provide the ability for web applications to send real-time data to another web application whenever an event occurs. Webhooks allow integrating data into other systems. Each webhook is capable of containing multiple triggers and conditions.
Webhooks are set up when you need to inform other systems of shipment status updates, label generation or other supported event types. Webhooks can be set up for Shipments & Return Requests.
Permissions: Only users with Admin/Account Manager and IT Manager access roles are able to create and manage webhooks.
Setting up a webhook
1. Navigate to Settings > Integration > Webhooks on the Carriyo Dashboard.
2. In the Webhooks listing page, click on the add icon at the top right corner to create a new webhook.
2. Appropriately name the webhook and select the webhook type. Possible options are Shipment and Return Requests. Provide the endpoint URL for the webhook. For any event that triggers this webhook, the request/data will be sent to this URL.
3. It is recommended that webhook authentication be enabled. If this toggle is switched on, the necessary fields are to be filled. Content Type can be either application/x-www-form-urlencoded
or application/json
. A webhook header will automatically be configured based on the Content Type selected.
Additionally, Authentication headers and Custom Parameters can be set. To add a new header/parameter, click on the + add record button and add the key value pair.
4. The next step is to configure the Webhook headers and triggers. To learn more about Carriyo webhooks, visit the link provided in the description. Similar to above tables, click on + add record to add the key value pairs.
5. To add a trigger event, select an event from the dropdown and click on Add Trigger.
Table records can be either edited or deleted by clicking on the menu (three-dot) option.
6. Configure Merchant Restrictions. Enabling Allow all merchants option allows the webhook to be applied to all merchants, including those added in the future. If Select Merchants option is selected, select the required merchants from the dropdown.
Add conditions for the webhook to be applied only to specific scenarios. Conditions can be added by clicking on the + add condition button and to delete a condition, click on the minus (−) symbol beside it.
7. Click on Save once all changes are made.
Managing Webhooks
Possible options on a webhook are edit, duplicate, and delete. Clicking on the webhook name also enables editing.
The change log keeps track of all changes made to the specific webhook and the source responsible for each of those events. Click on view change log to display it. Options to duplicate and delete are available on the Create/Edit webhook page.
Activating/Deactivating webhooks
When webhooks are used sporadically over extended periods, deactivating them facilitates decluttering and saves time. Users have the option to activate them at a later time.
Comments
0 comments
Please sign in to leave a comment.