A web alert, also known as webhook, is an automated notification sent from the API server when triggered by a specific action that occurs in your portfolio. You can configure the actions that trigger the alerts to notify you of any event that’s important to your business model. The Web Alerts page contains information about notifications associated with your account and allows you to create new alerts or edit existing ones.
Note
By default, all Web Alerts are disabled. You must enable alerts by using the Add Alert feature on this page.
To learn more about web alerts, see Setting Up Web Alerts.
To access the Web Alerts page, select Web Alerts in the Admin category of the left navigation panel.
Web Alerts Features
Click here to view the features of the Web Alerts page.
Create Web Alerts Link
The Create Web Alerts Link is located at the top of the page, and contains a link to the specific view for the portal for the user with access to the Web Alerts page. You can use the Create Web Alerts link to sign up with another site that periodically pulls notifications based on the configuration of that third party site.
Copy the link using the Clipboard icon and paste to your browser to open the Web Alerts API information.
Add Alerts
To create a new alert for your account:
Click ADD ALERT in the upper-right corner of the web alerts table.
Enter a Name and Description for your web alert.
(Optional) Click Advanced Options at any time to set specific criteria for Logins or Teams.
Click Next.
Enter your Endpoint web address and any required Header Name and Header Value.
(Optional) Click Add Another Endpoint to enter additional endpoint addresses.
Click Next.
Select your desired platform resource from the Resource dropdown.
Select the applicable event from the Event dropdown.
Note
See Setting Up Web Alerts (Webhooks) for a comprehensive table of Resources and Events you can activate web notifications for.
(Optional) Enter a Name and Description for this alert trigger.
Click Add.
Result: Your new Web Alert is configured and notifications will be sent for the Resource and Event combination triggers provided.
Saved Web Alerts
The Saved Web Alerts section displays a table of alerts saved to your account, including the following information:
ID: The Payrix Pro-generated ID associated with the saved alert.
Login: The Payrix Pro-generated ID assigned to the user account that created the alert.
For Login: The Payrix Pro-generated ID assigned to the user account that is tracked to trigger the web alert.
Name: The name of the web alert.
Description: A description of the web alert.
Status: Whether the alert is active or inactive.
Saved Web Alerts Table Actions
The Saved Web Alerts table supports the following actions: delete an alert and access more information about a saved alert.
To delete an alert:
Click the X icon in the far right column of the table to open the Delete Alert lightbox.
Click YES in the lightbox to delete the alert.
To access more information about a specific saved alert, click any information in the row to open the Alert Details.
Related pages
Click the links or items on the page to access any of the following pages: