Use Case: Enable Invoice Event Alerts

1. Open the Email Alerts Invoices Tab

• Step 1: Click Email Alerts under the Admin category in the left navigation panel to open the Email Alerts page.

• Step 2: Click the Invoices tab at the top of the page.

2. Create a New Email Alert

• Step 1: Locate the invoice event type on the Invoices tab. Choose from the following types:

  • Invoice Created

  • Invoice Cancelled

  • Invoice Expired

  • Invoice Viewed

  • Invoice Paid

  • Invoice Emailed

  • Invoice Result Failure

• Step 2: Click the Minus icon on the right side of the invoice event to activate the alert.

• Step 3: Click the Triangle icon to the left of the invoice event title to open the event type options section.

• Step 4: Enter the email address of the alert recipient in the email field.

Warning: 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.

Tip: Use the admin or account manager’s email address to ensure notifications are not missed and that alerts are confidential.

• Step 5 (Optional): Click the Plus icon to add fields for additional recipients and enter their email addresses. Click the Minus icon to remove email recipients.

• Step 6: 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 invoice event type occurs.

1. Open the Web Alerts Page

• Step 1: Click Web Alerts under the Admin category in the left navigation panel to open the Web Alerts page.

• Step 2: Click ADD ALERT in the upper-right corner of the page to open the Add Alert lightbox on the page.

2. Name the New Web Alert

• Step 1: Enter the name of the new alert in the Name field in the first section of the Add Alert lightbox.

• Step 2 (Optional): Enter an optional description of the alert in the Description field.

• Step 3 (Optional): Click Advanced Options to enter information about the login ID, team, partition, or division associated with the alert.

Tip: You can enter the optional advanced options during any step of the setup process.

• Step 4: Click Next in the lower-right corner of the lightbox to move to the next section.

Tip: Click Prev in the lower-right corner to go back to a previous section at any time.

3. Attach your Endpoints receiving the Web Alert

• Step 1: Enter the endpoint in the Endpoint field. The endpoint is the URL address on your server that receives the alert from Payrix.

• Step 2 (Optional): Enter the header name and header value in the open fields under the Endpoint field.

• Step 3 (Optional): Click Add Another Endpoint to add additional endpoints. Click the Trashcan icon to remove an endpoint.

• Step 4: Click Next in the lower-right corner of the lightbox to move to the next section.

4. Set Invoice Event Web Alert Triggers (Alert Resources)

• Step 1: Select Invoices from the Resource drop-down menu.

• Step 2: Select the type of event that triggers the alert from the Event drop-down menu.

  • Invoice Created

  • Invoice Cancelled

  • Invoice Expired

  • Invoice Viewed

  • Invoice Paid

  • Invoice Emailed

Tip: Alternatively, you can use the InvoiceResults resource for web alerts for invoices that return in a Failed status.

• Step 3 (Optional): Enter a name and description in the fields below the Resource and Event fields.

• Step 4 (Optional): Click Add Another Trigger to add additional alert triggers. Remove a trigger by clicking the Trashcan icon to the right of the trigger.

• Step 5: Click Add to finish setting up the new web alert.

Result: The new web alert triggers when the resource and event occur.