You can create an alert that notifies you every time a subscription plan is created or changes status. To receive notifications about subscriptions associated with your account, you can set up email alerts or web alerts (also known as webhooks) in the Payrix Pro portal. This tutorial shows you how to configure an email or web alert for subscription creation or status change events.
Audience: partner, Merchant
Enable Subscription Event Alerts
Ensure that you complete the prerequisites and all steps in a section to enable that alert type.
Note
By default, all custom email and web alerts are disabled. The platform provides a set of default email alerts when a Merchant is boarded to cover critical notifications. To learn more about boarding alerts, see the Enable Merchant Boarding Alerts use case.
Prerequisites
Before attempting this tutorial, you must:
Meet the general prerequisites described in Get Started with Use Case Tutorials.
Enable Email Alerts for a Subscription Event
Complete all steps in the following sections.
Open the Email Alerts Subscriptions Tab
Click Email Alerts under the Admin category in the left navigation panel to open the Email Alerts page.
Click the Subscriptions tab at the top of the page.
Create a New Email Alert
Locate the subscription event type on the Subscriptions tab. Choose from the following types:
Subscription Created
Subscription Approved
Subscription Failed
Click the switch on the right side of the subscription event to activate the alert. When not subscribed, the switch will display a minus symbol. When subscribed, the switch will display a check.
Click the Triangle icon to the left of the subscription event title to open the event type options section.
Enter the email address of the alert recipient in the email field.
Important!
Email alerts are not sent to a newly provided email address until it is verified. You can verify a new email address by following the instructions in the initial enrollment email sent to the user.
(Optional) Click the Plus icon to add fields for additional recipients and enter their email addresses. Click the Minus icon to remove email recipients.
Click SAVE in the upper-right corner of the section to finish setting up the alert.
Result: The recipients receive an email alert when the specific subscription event type occurs.
Enable Web Alerts (Webhook Notifications) for a Subscription Event
Complete all steps in the following sections.
Open the Web Alerts Page
Click Web Alerts under the Admin category in the left navigation panel to open the Web Alerts page.
Click ADD ALERT in the upper-right corner of the page to open the Add Alert dialog on the page.
Name the New Web Alert
Enter the name of the new alert in the Name field in the first section of the Add Alert dialog.
(Optional) Enter an optional description of the alert in the Description field.
(Optional) Click Advanced Options to enter information about the login ID, Team, partition, or Division associated with the alert.
Click Next in the lower-right corner of the dialog to move to the next section.
Attach your Endpoints Receiving the Web Alert
Enter the endpoint in the Endpoint field. The endpoint is the URL address on your server that receives the alert from Payrix Pro.
(Optional) Enter the header name and header value in the open fields under the Endpoint field.
(Optional) Click Add Another Endpoint to add additional endpoints. Click the Trashcan icon to remove an endpoint.
Click Next in the lower-right corner of the dialog to move to the next section.
Set Subscription Event Web Alert Triggers (Alert Resources)
Select Subscriptions from the Resource dropdown menu.
Select the type of event that triggers the alert from the Event dropdown menu:
Subscription Created
Subscription Approved
Subscription Failed
(Optional) Enter a name and description in the fields below the Resource and Event fields.
(Optional) Click Add Another Trigger to add additional alert triggers. Remove a trigger by clicking the Trashcan icon to the right of the trigger.
Click Add to finish setting up the new web alert.
Result: The web alert automatically triggers when the specific subscription event occurs.
Next Steps
After enabling the subscription alert, review the following guides on enabling other alerts:
Enable Invoice Event Alerts: Create an email or web alert that triggers when an invoice is created or updated by you or one of your users.
Enable Chargeback Event Alerts: Create an email or web alert that triggers when a chargeback update, creation, or final decision occurs under your portfolio.
Enable Transaction Event Alerts: Create an email or web alert that triggers when a transaction status changes.
Enable Merchant Boarding Alerts: Create an email or web alert that triggers when Merchants' boarding status changes.
Enable Disbursement Event Alerts: Create an email or web alert that triggers when withdrawals or negative disbursement events occur or change status.