Setup Webhooks in Admin Panel

Experro allows you to create webhooks and send real-time data to any third-party application or service when a specific event occurs. You can check this article to learn more about the webhook events. 

What are webhooks?

Webhooks in Experro are custom HTTP callbacks designed to keep your application informed in real time about significant events within your environment. This ensures that you stay well-informed about crucial changes and can take the appropriate actions when they happen.

Why set up webhooks?

Setting up webhooks can be highly beneficial in various scenarios where you want to receive real-time updates or events from one system or service to another. Let's explore an illustrative example to understand why you might want to set up webhooks:

Use Case: E-commerce Order Processing

If you are running an e-commerce store online and you want to make the order processing workflow more efficient, you have to ensure that your inventory is updated, the shipping department is notified as soon as an order is placed, and the customer is kept informed about the order status. This can be achieved effectively with the help of webhooks.

1. Inventory Management
   • Without Webhooks: In a non-webhook scenario, you may need to regularly retrieve and update inventory data from your e-commerce platform's API. However, this can result in delays in updating your inventory and potentially cause issues if a product runs out of stock.
   • With Webhooks: Setting up webhooks allows your e-commerce platform to send real-time notifications to your inventory management system when a product is purchased, triggering automatic updates of inventory and ensuring accurate stock levels at all times.
2. Order Processing

   • Without Webhooks: In a traditional setup, the shipping department manually checks for new orders at intervals, causing processing delays.

   • With Webhooks: When an order is placed, webhooks can instantly notify your shipping system, allowing your shipping department to process the order immediately and improve order fulfillment speed and customer satisfaction.

3. Customer Notifications

   • Without Webhooks: Customers often contact support for order status despite receiving periodic email updates for order confirmation and shipment tracking.

   • With Webhooks: Real-time updates can be triggered to your customer notification system through webhooks. Whenever an order is shipped or there is any change in the order status, customers are instantly notified via email or SMS. This ensures a better customer experience by keeping them informed throughout the entire order process. 

4. Error Handling

   • Without Webhooks: In a non-webhook scenario, errors may go unnoticed, leading to customer complaints and manual resolutions.

   • With Webhooks: If there are any issues with order processing, payment failures, or other errors, webhooks can be utilized to instantly notify relevant teams or systems. This enables prompt identification and resolution of problems.

In the context of e-commerce, webhooks play a crucial role in automating order processing workflows and improving their efficiency, accuracy, and responsiveness. Instead of relying on periodic data updates or manual checks, webhooks provide immediate notifications when specific events occur. This allows you to take timely actions, which can significantly enhance the customer experience and operational efficiency across various applications and industries. Therefore, webhooks are a valuable tool for real-time communication and automation.

Now let us see how you can create, update, or delete webhooks in the Experro admin panel.

Create a Webhook in Experro

You can set up webhooks using our APIs or directly from the admin panel of Experro by following the below steps: 

1. Go to your workspace.

2. Navigate to Settings > General > Webhooks.

3. If you've created webhook records before, you'll be directed to a screen displaying the list of existing webhooks. Otherwise, you can begin the process of adding a new webhook.

   

4. Click on the +Add Webhook button in the top right corner.

5. You will be directed to the configure webhook page where you need to add the below details:

   • Name Required: Provide a suitable name for your webhook.

   • URL Required: Specify the URL or web address where the data will be sent once the webhook is triggered. The URL will receive an HTTP POST request when the selected event occurs.

   • Active: Webhook calls will be executed for the events that have been activated. Click on the toggle button to enable or disable the webhook.

   • Environment Required: Select the environment in which you want the webhook to trigger.

   • Headers Optional: There are 3 types of header options available:

     • Add Custom Header: This field lets you add any additional Custom header to the HTTP POST request. You can add multiple headers by clicking the + Add Custom Header button.
     • Add Secret Header: This field lets you add any additional Secret header to the HTTP POST request. You can add multiple headers by clicking the + Add Secret Header button.
     • Add HTTP Basic Auth Header: This field lets you add any additional Auth header to the HTTP POST request. You can add multiple headers by clicking the + Add HTTP Basic Auth Header button

   • Specific Triggering Events Required : Indicate the types of event that should trigger this webhook i.e. you need to select the:

     • Object: Module where you want this webhook to trigger, in this case 'Content Model'.
     • Model: Select the models you created in that module where you want this webhook to trigger.
     • Actions: Select the actions for when you want this webhook to trigger. i.e. Create, Update, Delete, Publish, or Unpublish.
       
       
6. Click on the Save button.

Update a Webhook in Experro

You can always modify an existing Webhook whenever required.
You just need to follow the below steps to quickly make changes to an existing webhook:

1. Go to your workspace.

2. Navigate to Settings> General > Webhooks.

3. You will be directed to the screen where you will see the list of existing webhook records if created previously otherwise you can add webhooks.
   
   

4. Click on the webhook that you want to update and make the necessary changes to the configuration fields of the webhook.

5. Save the changes.

Delete a Webhook in Experro

You can delete the webhook if you no longer need it. To delete a webhook, log in to your Experro account, and follow the below steps:

1. Go to your workspace.

2. Navigate to Settings> General > Webhooks.

3. You will be directed to the screen where you will see the list of existing webhook records if created previously otherwise start to add webhook.

4. Hover over the webhook you want to delete, click on the three dots icon that appears beside the webhook name, and select the Delete option.
   
   
5. Confirm to delete the webhook, and it will be removed permanently.