A web alert (also known as a “webhook”) is a notification sent from the API to your server that triggers when a set event occurs in your portfolio. For example, when a new Merchant is added to your portfolio, their onboarding status will initially be set to Not Ready. You can create a web alert to notify your server when this status changes to Boarded, indicating that the Merchant has been approved to start processing payments.
A web alert is made up of three parts:
Alert: Defines which users are monitored and packages the full configuration, including triggers and actions.
Alert Trigger: Specifies the events that activate the alert, with support for multiple triggers per alert.
Alert Action: Determines the alert’s delivery settings, such as email, SMS, or webhook, and includes retry and format options.
Set Up a Web Alert
You can use the Payrix Pro portal to configure different web alerts based on your needs.
To set up a web alert:
Access the Web Alerts page from the left navigation panel.
Click Add Alert.
Set the Name and Description for the Alert. Then, click Next.
Provide at least one endpoint, also known as the destination URL, such as webhook.site or an in-app mobile service, and configure any necessary headers.
Note: You can provide multiple endpoints, if needed.Select the Payrix Pro Resource to monitor and the Event that triggers the web alert.
Click Add.
Result: You have created a new web alert that will trigger when the events you specified occur under the specific users you’ve designated.
Add Alert Triggers
After setting up your web alert, you can also specify additional events that can trigger the same web alert.
To add more Alert Triggers:
Access the Web Alerts page from the left navigation panel.
Select the relevant web alert to open the Alert Details page.
Click Add Alert Trigger.
Select another Resource and Event value.
(Optional) Add a Name and Description for the Action Trigger.
Click Add.
Result: You have successfully added another set of conditions to activate the alert action when the specified event occurs.
Add Alert Actions
With your triggers and alerts set, you can add more delivery methods for receiving alerts.
To add more Alert Actions:
Access the Web Alerts page from the left navigation panel.
Select the relevant web alert to open the Alert Details page.
Click Add Alert Action.
Provide the Endpoint, Header Name, and Header Value.
Click Add.
Result: You have successfully added another delivery method for alerts to ensure they can be delivered to multiple communication channels.