A web alert (also called a webhook) is a notification sent from the Payrix Pro API to your server when a specific event occurs in your portfolio. For example, you can set up a web alert to notify your server when a new merchant’s onboarding status changes from Not Ready to Boarded to indicate the Merchant is approved to process payments.
A web alert is made up of three parts:
Alert: Defines which users and resources are monitored and includes the full configuration of triggers and actions.
Alert Trigger: Specifies the events that activate the alert.
Alert Action: Sets delivery options (email, SMS, or webhook), including retry and format settings.
The following sections explain how to configure each part. For step-by-step setup instructions for specific events, see Use Cases: Alerts.
Define Who Your Alerts Monitor
When you create an alert, you must define who the alert targets and monitors. Enter your Login ID, or another applicable Login ID, to indicate ownership. If you do not provide a Login ID, the Payrix Pro Portal defaults to ID of the user setting up the alert.
Then, choose one of the following to set the monitoring scope:
For Login: Monitors a specific user’s activities.
Team: Monitors all users within a Team.
Division: Monitors all users within a Division.
Note
Only one monitoring scope can be set per alert. A Login ID is always required, but only identifies the alert owner, not the monitored user or users.
By default, the Division field is auto-filled, but can be removed and replaced by entering an ID for the Team or For Login fields.
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:
Select Web Alerts from the left navigation panel.
Click Add Alert.
(Optional) Enter the Name and Description for the Alert.
Enter your Login ID (or the Login ID of the user that owns this alert).
Set the scope using one ID: For Login, Team, or Division.
Click Next.
Enter your Endpoint (such as webhook.site or a mobile service).
Enter the required Header Name and Header Value.
Click Next
Select a Resource and Event that triggers the web alert.
Click Add.
Result: Your alert is active and triggers when the selected event occurs for the target.
Add Alert Triggers
After setting up your web alert, you can also add more event triggers to the same web alert.
To add more Alert Triggers:
Select Web Alerts 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: Your additional conditions now activate the alert.
Add Alert Actions
With your triggers and alerts set, you can add more delivery methods for receiving alerts.
To add more Alert Actions:
Select Web Alerts 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: Alerts are now delivered to multiple channels.