Picture of An Introduction to Webhooks in Infigo | BG_082

An Introduction to Webhooks in Infigo | BG_082

This video provides an in-depth introduction to using webhooks within the Infigo platform. It explains the advantages of implementing webhooks over traditional API polling methods, highlighting how webhooks can automate notifications for various status updates like order completions, shipping, and printing events. The tutorial covers the configuration process, including setting up endpoints, selecting HTTP methods, and customizing headers for authentication. Viewers will also learn how to manage data formats and optimize webhook settings based on urgency and event volume, ensuring efficient and scalable integrations for their systems. This session is essential for users looking to enhance their workflow automation with Infigo's webhook capabilities.

Tutorial Video Transcript

0:01 So a quick introduction to webhooks. We have those in the system for a while, but actually actively promoting those right now.
0:12 Maybe very quickly for those who don't know what this is for, but basically the API is a one way direction where you query Infigo about information.
0:25 So that means in case you want to understand about changes, you would have to consistently ask the API for changes and poll information.
0:36 And the webhook system will allow you to set up and configure endpoints where in figure will send out an event.
0:46 So basically you would be notified about those changes as they happen and basically you wouldn't have to poll, saving yourself some resources, us some resources, we have some customers who will actually use this quite extensively right now so they can certainly benefit from switching over to web hooks
1:06 for those status updates when items are being printed, shipped, orders completed, etc. For the sake of this demonstration, I will quickly set up one.
1:22 Obviously, I don't have an endpoint which could consume this. For that, I use a service called pipe dream, which I'll show you in a second, though, it's just visually possible to see this.
1:36 But when you go to Webhooks and Admin, we can set up a new one. And basically can give this a name.
1:48 And the main important thing for Webhook is that you specify an endpoint which we should call one when this comes in.
1:58 And Pipedream basically, this is a service which you can use to set up and do some of those migration tasks, but obviously you would use your application for it.
2:09 It just gives us an endpoint which we can call, so I can copy this into a clipboard and use this here.
2:21 And then I can specify different methods if it's a get or a post or some additional HTTP verbs can be used as well.
2:31 You can add some headers here for authentication or anything else in order you want to use this. And maybe it was important, you can change the mode, how those webhooks are being triggered.
2:43 The default one is delayed, which means whenever the change happens, it doesn't send the We're pulled out immediately, it batches them up, a background task process is that, that is just very good for us to save resources, and if it's not really time-critical, it wouldn't matter if there is a slight 
3:04 delay in a few minutes. Delayed in batches will basically actually send out large batches, so if for large volume sites, where you have hundreds, if not thousand orders a day, And a lot of things move that makes a lot more sense because you will not get individual calls for each one But actually it batches
3:26 them up there. It will be some sort of CSV style data being sent to you where you have an information about All their elements which are being changed for the sake of the demonstration we do time critical which send them out Very quickly as soon as the event happens and then you can specify What is the
3:46 entity you want to be informed about an order, customer order line and product and changes and you can say what will be the events you would like status updates, cancel status deleted, created, updated or all of the above and basically that's when this webhook will be triggered and you can use multiple
4:07 webhooks for different things for different statuses or have them combined and then you can finally specify the data type and you see a sample of what this would look like and that you can use JSON, XML, etc.
4:21 and what is also very nice is for XML. You can use XSLT to transform this data to a format which your site understands.
4:30 you can test this XSLT transformation here to see what this will look like, but for now we will basically send just some standard XML for this purpose.
4:44 So let's save and create this this web hook and now theoretically as soon as something changes we should see this coming up here.
4:55 And because they've done an order line change, we could go into Shared Print Ops quickly and choose one of our jobs.
5:08 Michael, just quickly. Yalfeng is just asked and I won't get you on for this because it might be a short question answer, but if you've got anything else you want to add, you can jump on, but is this This is the webhook, the webhook page is already available to all of our customers on the call at the
5:24 moment. Yes, it is. It is available, right? So you should be able to find it in admin just by searching webhook for webhook.
5:32 So for example, if I change to the status here now, it will update here. And under the hood, the Infigo system will send out the webhook based on the configuration we've had here.
5:50 I took some time to see here now they came in there you go Chris thank you for filling that void thank you very much you can time critical is not immediate but it will send it out fairly quickly and then you see here all the events the status code which came back and you can see the original request 
6:10 the transformed request in case I would have you see the response which came from pipe dream and the response headers and when we go in here, we also see them coming in now.
6:26 You can inspect them in a bit more detail. What is the data which has been transformed here and you see here our ID for example and the name of those changes.
6:44 And here as well, for example, in this instance, I just set it up that it stores the data of those changes and pings them in a request store, and that's basically how you can do this.
7:03 So, Mike, if our customers are going to want to fetch some information from Infigo, what are the sort of questions they need to ask themselves to determine whether they should do it via the API or via the web hooks as well?
7:16 Well, it's basically whenever you, or you want to look at a status update, that's where you should start using the web hook instead rather than polling.
7:27 Because obviously if you pull and you have a couple hundred active jobs there that is a couple hundred active API calls when you do one for the order and then several for the order lines potentially it adds up even more while this will get you an information whenever you need it based on on the change
7:47 . so it saves resources on your end, it saves resources on our end, and makes the integration much nice and smooth.
7:55 And when you think about larger scale platforms with many orders, doing it through polling is almost ridiculous, and the webhook is the way to go.
8:05 And they said it's very flexible in the way it can be set up, different events, different transformations on the data you can use get requests or post requests etc to really fill whatever you use to consume this you.

Incomplete
Guide

Understanding Webhooks in Infigo

 

1. Introduction to Webhooks 0:01

generated-image-at-00:00:01

  • Webhooks have been available in the system for a while but are now being actively promoted.

  • They provide a way to receive notifications about changes without polling the API.

 

2. Difference Between API and Webhooks 0:12

generated-image-at-00:00:12

  • API: One-way communication where you query Infigo for information.

  • Webhooks: Two-way communication where Infigo sends notifications about changes to a specified endpoint.

 

3. Benefits of Using Webhooks 0:36

generated-image-at-00:00:36

  • Eliminates the need for constant polling, saving resources for both users and Infigo.

  • Useful for receiving status updates on printing, shipping, order completions, etc.

 

4. Setting Up a Webhook 1:22

generated-image-at-00:01:22

  • Navigate to Webhooks in Admin to create a new webhook.

  • Provide a name and specify an endpoint for Infigo to call.

 

5. Using Pipedream for Endpoint Testing 1:58

generated-image-at-00:01:58

  • Pipedream is a service used to set up endpoints for testing.

  • Copy the endpoint URL from Pipedream to use in the webhook setup.

 

6. Configuring Webhook Settings 2:21

generated-image-at-00:02:21

  • Specify HTTP methods (GET, POST) and add headers for authentication.

  • Choose the mode for triggering webhooks: delayed or immediate.

 

7. Choosing the Trigger Mode 2:43

generated-image-at-00:02:43

  • Delayed mode batches notifications to save resources, suitable for high-volume sites.

  • Immediate mode sends notifications as events happen, useful for time-critical updates.

 

8. Selecting Entities and Events 3:46

generated-image-at-00:03:46

  • Specify which entities to receive updates for (e.g., order, customer, product).

  • Choose events to trigger the webhook (e.g., created, updated, deleted).

 

9. Data Format Options 4:21

generated-image-at-00:04:21

  • Choose data types for the webhook (JSON, XML).

  • For XML, use XSLT to transform data into a desired format.

 

10. Saving and Testing the Webhook 4:44

generated-image-at-00:04:44

  • Save the webhook configuration.

  • Test the webhook by changing an order line status.

 

11. Monitoring Webhook Responses 6:10

generated-image-at-00:06:10

  • Inspect incoming webhook events and responses in detail.

  • View transformed data and original requests.

 

12. Deciding Between API and Webhooks 7:03

generated-image-at-00:07:03

  • Use webhooks for status updates instead of polling the API.

  • Webhooks are more efficient for larger platforms with many orders.

 

13. Flexibility of Webhooks 8:05

generated-image-at-00:08:05

  • Webhooks can be set up flexibly with different events and data transformations.

  • Support for various HTTP methods enhances integration capabilities.

Link to Loom

https://loom.com/share/981f9d3d63194be3bf274eb13233420d

Q&A

Q: Why can't I access the webhook functionality mentioned in this tutorial?
A: We may need to provide access to webhook management on your platform. Please contact Customer Support who can enable this for you.

Alternate Search Terms

Individual Search Words:
notifications, automation, integration, triggers, endpoints, configuration, real-time, status, events, connectivity

Alternate Search Phrases:
automatic notifications setup, event-driven updates, API-less communication, configure status alerts, manage data endpoints, webhook automation tutorial, system event monitoring, instant status updates, integration setup guide, real-time event handling