Webhook Subscription

Mageplaza Webhook helps Magento 2 stores configure to send an API request to a configurable destination (URL) when specific event entities occur. This useful tool supports businesses to update instant, real-time notifications.

Features

• Trigger API requests on specific events
• Trigger API requests upon cart abandonment
• Send leads/customer data to CRM or Email Marketing tools
• Log requests and responses
• Report request errors
• Work well with Mageplaza SMTP

Problems & Solutions

Understanding the concept of webhooks is similar to a doorbell system scenario. Picture a doorbell with a button and a bell; when a visitor presses the button, the doorbell rings, signaling someone is at the door. Similarly, webhooks are user-defined HTTP callbacks activated by specific events. When a trigger event occurs on the source site, the webhook identifies the event, gathers data, and sends it to a specified URL via an HTTP request.

In terms of solutions, Mageplaza Webhook is designed to: 

• Promptly recognize events, ensuring synchronized data across multiple web applications. 
• In a shipping method service, specific webhooks can be assigned to distinct shipping methods (e.g., air, rail, sea). 
• Facilitate the connection between two or more applications, where an event in one triggers an event in another.

Highlight features

Instant API requests on event occurrence

Mageplaza's Magento 2 Webhook quickly identifies and sends API requests to external servers or applications when specific events happen.

API requests for cart abandonment

Notably, Magento 2 Webhook enables API requests when cart abandonment takes place, helping e-businesses prepare for quick issue resolution or customer support.

Seamless CRM and Email Marketing integration 

Automatically transmit new data (such as orders or customer updates) to CRM and/or Email Marketing systems.

Efficient log management

Webhooks support logs, allowing admins to promptly update the hook status as success or error, with clear error messages for quick review.

More features

Alerts for API requests

Get email notifications for errors when sending API requests.

Auto-clear logs

Automatically clear logs when the total log count exceeds a specified number.

Request resending

Start a new request after resolving any errors.

Full Features List

Webhook for store admins

• Disable the extension
• Set time to send abandoned carts notice
• Allow sending an alert email when an error occurs
• Select email template
• Set a total number for keeping logs
• Clean logs daily
• Resend hook feature
• Order Status selection for Order hook

Manage Hooks

• Set name for a new hook
• Set status, store view, priority for the hook
• Input Payload URL
• Select Method for sending requests
• Input Header for the hook
• Select the Method for sending requestsrity for the hook
• Insert variables to the body and preview
• Manage hooks via a grid
• Compatible with other Mageplaza extensions (Countdown Timer Clocks, Better Sorting, Payment Restrictions, Salesforce Integration)

Hook Logs

• View all status, entity, a message of logs
• View error messages of logs
• Select action for a log: Preview response or Replay (with fixed logs)

FAQs

1. What is the purpose of Auto-Clear Logs in Mageplaza Webhook?

Auto-Clear Logs automatically cleans logs when the total log count exceeds a specified number, ensuring efficient log management.

2. Is there a limit to the number of logs in Mageplaza Webhook?

Yes, Mageplaza Webhook allows you to set a specific number as a threshold, and logs are automatically cleared when this threshold is reached.

3. How can I create a hook?

Follow these steps:

• From the Admin Panel, go to System > Webhook > Manage Hooks.
• Choose the Add New button in the right corner.
• Fill in the hook information and click on Save.

4. Where can I check logs?

• From the Admin Panel, go to Mageplaza > Webhook > Logs This section will record all the Webhooks change logs.
• When you click on any file, it will auto-open that file.
• Click View, it will redirect the email receiver to the Logs page to view the detailed logs.

Documentation

User guide | Installation guide