Objective: To understand the role of webhooks and how Duro uses them to optimize your experience.
Difficulty: Intermediate
In this article:
- Overview
- Customization and advantages
- Navigating to the Duro Webhooks table
- How to create a webhook
- Tracking integration activity
Overview
Webhooks are the way in which information is delivered from one application to another in real time. More specifically, they are HTTP requests that are automatically generated by an action or event within one system. The payload of this HTTP request contains information about the action or event and the request is sent to a user-provided destination endpoint. Examples of webhook connections within Duro include the approval or rejection of Change Orders.
Customization and advantages
Utilizing webhook APIs brings significant benefits to Duronauts. These APIs offer a user-friendly approach to API design, deployment, and management through self-service developer portals. Duronauts have the option to build webhooks around updates pertaining to Change Orders and components. Change Order webhooks include submission, approval, and rejection, and component webhooks include creation, updates, and deletions. For more information on APIs, please refer to the Quick Start Guide to using Duro's GraphQL API.
Webhooks can be harnessed to provide you with far more information than just Change Order approvals, rejections, or components updates. Use Duro’s API to create webhooks that push data on your assemblies, components, and products into an external source, such as Excel or a SQL table, for reporting and tracking purposes. Duro is happy to supply you with documentation to aid you in the creation of your own custom webhooks. Please reach out to info@durolabs.co for more information.
Navigating to the Duro Webhooks table
Navigate to the Webhooks Table within Duro to view the Webhook configuration through the following steps:
- Login to your Duro account
- Click on your avatar.
- Click on Account settings.
- Within the Settings menu, click on Webhooks.
This will present the Webhooks Table. All connection points between plugins for data integration and Duro are synced here. Each line item in the table contains a webhook to a different connection point. You’ll see line items showing webhooks to your API-driven connections.
How to create a webhook
Once you’re logged into Duro and have navigated to the Webhooks Table, follow the instructions below to create a new webhook.
- Click on the New button to open the New Webhook module.
- Enter the desired URL endpoint for the webhook into the “Webhook URL” field. This endpoint needs to return a standard HTTP “200 OK” response on successful receipt of the HTTP request. Duro will not consider the request successful if a “200 OK” response and may periodically retry the request with the same information.
- Enter a description into the coordinating field. This can be anything that you may find helpful, and there are no description requirements.
- Select the event types you would like to be notified of:*
- Change Order Events:
- Change Order Submitted
- Change Order Approved
- Change Order Rejected
- Component Events:
- Component Created
- Component Updated
- Component Deleted
- Change Order Events:
- Select the mode: Live or Sandbox.
- Optional: Check the box for “Include all Components and Products Data.” This box is for Change Orders, as component information is already supplied for component events.
- Click SAVE.
Your webhook is now enabled.
Note: Only administrators are able to create webhooks, which are set at an organizational level.
Tracking integration activity
One of the advantages of using Duro is that you can track activity through the Webhooks table. For instance, if you wanted to check on the status of an approved Change Order, clicking on a webhook link within the table would populate the "Webhook Event Log." This would show the following information on an approved Change Order:
- The status will show as “Delivered”
- The Event Type will show as “co:Approved”
- The Created column will have the time stamp when the Change Order was approved
Comments
0 comments
Please sign in to leave a comment.