Alert Details (R)

This topic describes the following pages:

  • Alert Details

  • Alert Action Details

  • Alert Trigger Details

The Alert Details page contains information about a specific Web Alert saved to your account. On this page, you can view and edit details about the alert, or create additional alert actions and alert triggers.

Navigate to the Alert Details page by clicking Web Alerts in the Admin category of the left hand navigation panel, then clicking any information in the Saved Alerts table.

Partial view of the Alert Details page, including the Alert Details Information and the Alert Actions sections.

Alert Details Features

Alert Details Panel

The Alert Details panel contains editable information about a specific saved web alert, including the following fields:

Alert Details Field Name

Description

Alert Details Field Name

Description

ID

The Payrix-generated ID number associated with the web alert.

Created

The date that the web alert was created.

Name

The name of the web alert.

Description

A description of the web alert.

Status

The status of the alert: Active or Inactive.

Login

The Payrix-generated ID assigned to the user account that created the alert.

For Login

The Payrix-generated ID assigned to the user account that is tracked to trigger the web alert.

Team

If a Payrix Team receives the alert, the team name will be displayed in this column.

Division

If a Payrix Division receives the alert, the division name will be displayed in this column.

Alert Details Section Action

To edit information in the Alert Details fields, click the PENCIL icon in the top right hand corner of the section. Edit the information and save your changes by clicking the CHECKMARK icon, or discard your changes and return to the previous screen by clicking the X icon.

Alert Actions Panel

The Alert Actions panel displays a table of actions that are triggered by the web alert, and allows you to add a new action. The table contains the following information:

Alert Actions Table Column Name

Description

Alert Actions Table Column Name

Description

ID

The Payrix-generated ID associated with the alert action.

Content Type

The format of the alert action.

Header Name

The name displayed in the HTTP header, which is part of the API request associated with the alert.

Header Value

Any value displayed in the alert header, including authentication or other security flags.

Endpoint

The URL that receives the alert.

Alert Actions Section Actions

The Alert Actions section supports the following actions: add an action, remove an action, and access more information about an action.

To add an action follow the steps below:

  • Step 1: Click the ADD ALERT ACTION icon in the top right hand corner of the section to open the Add Alert Action lightbox.

  • Step 2: Enter the endpoint URL, and optionally enter the Header Name and Header Value.

  • Step 3: Add the new alert action by clicking ADD, or discard your changes and return to the previous screen by clicking CANCEL.

To remove an action follow the steps below:

  • Step 1: Click the X icon on the right hand side of the table row for the action that will be removed. The Delete Alert Action lightbox will open in the page.

  • Step 2: Click DELETE to remove the action. To retain the action and return to the previous page, click CANCEL.

To access more information about an alert action, click any information in the table row to open the Alert Action Details page.

Alert Triggers

The Alert Triggers section displays a table of actions that can initiate a web alert, and allows you to add a new trigger to the alert. The table contains the following information:

Alert Triggers Table Column Name

Description

Alert Triggers Table Column Name

Description

ID

The Payrix-generated ID associated with the alert trigger.

Event

The event that activates the trigger.

Resource

The resource associated with the trigger.

Name

The name of the trigger.

Description

A description of the trigger.

Alert Triggers Section Actions

The Alert Triggers section supports the following actions: add a trigger, remove a trigger, and access more information about an alert trigger.

To add a trigger follow the steps below:

  • Step 1: Click the ADD ALERT TRIGGER icon in the top right hand corner of the section to open the Add Alert Trigger lightbox.

  • Step 2: Enter the information in the lightbox.

  • Step 3: Add the new alert trigger by clicking ADD, or discard your changes and return to the previous screen by clicking CANCEL.

To remove a trigger follow the steps below:

  • Step 1: Click the X icon on the right hand side of the table row for the trigger that will be removed. The Delete Alert Trigger lightbox will open in the page.

  • Step 2: Click DELETE to remove the trigger. To retain the trigger and return to the previous page, click CANCEL.

To access more information about an alert trigger, click any information in the table row to open the Alert Trigger Details page.

Alert Action Details

The Alert Action Details page contains editable information about a specific action that occurs following a triggered web alert.

Navigate to the Alert Action Details page by following the steps below:

  • Step 1: Click Web Alerts in the Admin category of the left hand navigation panel.

  • Step 2: Click any information in the Saved Web Alerts table to access the Alert Details for a specific web alert.

  • Step 3: Click the information for an action listed in the Alert Actions table to open the Alert Action Details page.

Partial view of the Alert Action Details page, including the Alert Action Details Information Section.

Alert Action Details Features

Alert Action Details Information

The Alert Action Details Information section displays editable details about a specific alert action associated with your web alerts, including the following information:

Alert Action Details Information Filed Name

Description

Alert Action Details Information Filed Name

Description

ID

The Payrix-generated ID number associated with the web alert action.

Created

The date that the alert action was created.

Content Type

An HTTP protocol that formats the content of the HTTP request for the alert action.

Endpoint

The URL that receives the alert.

Header Name

The name displayed in the HTTP header, which is part of the API request associated with the alert.

Header Value

Any value displayed in the alert header, including authentication or other security flags.

Information Section Action

To edit information in the Alert Action Details fields, click the PENCIL icon in the top right hand corner of the section. Edit the information and save your changes by clicking the CHECKMARK icon, or discard your changes and return to the previous screen by clicking the X icon.

Alert Trigger Details

The Alert Trigger Details page contains editable information about a specific trigger associated with your web alerts.

Navigate to the Alert Trigger Details page by following the steps below:

  • Step 1: Click Web Alerts in the Admin category of the left hand navigation panel.

  • Step 2: Click any information in the Saved Web Alerts table to access the Alert Details for a specific web alert.

  • Step 3: Click the information for a trigger listed in the Alert Triggers table to open the Alert Trigger Details page.

Partial view of the Alert Trigger Details page, including the Alert Trigger Details Information section.

Alert Trigger Details Features

Alert Trigger Details Information

The Alert Trigger Details Information section contains editable details about the specific trigger for a web alert, including the following information:

Alert Trigger Details Information Field Name

Description

Alert Trigger Details Information Field Name

Description

Alert Trigger Details Information Field Name

Description

Alert Trigger Details Information Field Name

Description

ID

The Payrix-generated ID number associated with the web alert trigger.

Created

The date that the alert action was created.

Resource

The resource associated with the trigger.

Event

The event that activates the trigger.

Name

The name of the trigger.

Description

A description of the trigger.

Alert Trigger Details Information Section Action

To edit information in the Alert Trigger Details fields, click the PENCIL icon in the top right hand corner of the section. Edit the information and save your changes by clicking the CHECKMARK icon, or discard your changes and return to the previous screen by clicking the X icon.

Related pages

Click the links or items in the page to access any of the following pages: