This topic describes the following pages:
Webhook Details
The Webhook Details page contains information about a specific webhooks saved to your account. On this page, you can view and edit details about the webhooks or create additional webhook actions and webhook triggers.
Tip
For more information about the Alerts API endpoint, access the Alerts page in the Worldpay Developer Hub.
To access the Webhook Details page:
Click Webhooks in the Admin category of the left navigation panel.
Select any information in the Webhooks table.
Note
This article describes the Webhooks page in the Payrix Pro portal. For more information on setting up webhooks, available triggers, and use cases, visit Set Up Webhooks in the Implementation Guide.
Webhook Details Panel
The Webhook Details panel contains editable information about a specific saved webhook, including the following fields:
ID: The Payrix Pro platform-generated ID number associated with the webhook.
Created: The date that the webhook was created.
Name: The name of the webhook.
Description: A description of the webhook.
Status: The status of the webhook: Active or Inactive.
Login: The Payrix Pro platform-generated ID assigned to the user account that created the webhook.
For Login: The Payrix Pro platform-generated ID assigned to the user account that is tracked to trigger the webhook.
Team: If a Team receives the webhook, the team name will be displayed in this column.
Division: If a Division receives the webhook, the division name will be displayed in this column.
Webhook Actions Panel
The Webhook Actions panel displays a table of actions that are triggered by the webhook and allows you to add a new action. The table contains the following information:
ID: The Payrix Pro platform-generated ID associated with the webhook action.
Status: The status of the webhook: Active or Inactive.
Content-Type: The format of the webhook action.
Header Name: The name displayed in the HTTP header, which is part of the API request associated with the webhook.
Header Value: Any value displayed in the webhook header, including authentication or other security flags.
Endpoint: The URL that receives the webhook.
Webhook Actions Section Actions
The Webhook Actions section supports adding an action, removing an action, and accessing more information about an action.
To add an action:
Click ADD WEBHOOK ACTION in the upper-right corner of the section to open the Add Webhook Action dialog.
Enter the endpoint URL, and optionally enter the Header Name and Header Value.
Add the new webhook action by clicking Add.
To remove an action:
Click the X icon on the right side of the table row for the action that will be removed. The Delete Webhook Action dialog will open on the page.
Click CONFIRM to remove the action.
To access more information about a webhook action, click any information in the table row to open the Webhook Action Details page.
Webhook Triggers
The Webhook Triggers section displays a table of actions that can initiate a webhook and allows you to add a new trigger to the webhook. The table contains the following information:
ID: The Payrix Pro platform-generated ID associated with the webhook trigger.
Status: The status of the webhook: Active or Inactive.
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.
Webhook Triggers Section Actions
The Webhook Triggers section supports adding a trigger, removing a trigger, and accessing more information about a webhook trigger.
To add a trigger:
Click ADD WEBHOOK TRIGGER in the upper-right corner of the section.
Enter the information in the dialog.
Add the new webhook trigger by clicking Add.
To remove a trigger:
Click the X icon on the right side of the table row for the trigger that will be removed. The Delete Webhook Trigger dialog will open in the page.
Click CONFIRM to remove the trigger.
To access more information about a webhook trigger, click any information in the table row to open the Webhook Trigger Details page.
Webhook Action Details
The Webhook Action Details page contains editable information about a specific action that occurs following a triggered webhook.
To access the Webhook Action Details page:
Click Webhooks in the Admin category of the left navigation panel.
Click any information in the Webhooks table to access the Webhook Details for a specific webhook.
Click the information for an action listed in the Webhook Actions table to open the Webhook Action Details page.
Webhook Action Details Information
The Webhook Action Details page displays editable details about a specific webhook action associated with your webhooks, including the following information:
ID: The Payrix Pro platform-generated ID number associated with the webhook action.
Created: The date that the webhook action was created.
Content Type: The format of the webhook action.
Status: The status of the webhook: Active or Inactive.
Endpoint: The URL that receives the webhook.
Header Name: The name displayed in the HTTP header, which is part of the API request associated with the webhook.
Header Value: Any value displayed in the webhook header, including authentication or other security flags.
Webhook Trigger Details
The Webhook Trigger Details page contains editable information about a specific trigger associated with your webhooks.
To access the Webhook Trigger Details page:
Click Webhooks in the Admin category of the left navigation panel.
Click any information in the Webhooks table to access the Webhook Details for a specific webhook.
Click the information for a trigger listed in the Webhook Triggers table to open the Webhook Trigger Details page.
Webhook Trigger Details Information
The Webhook Trigger Details Information section contains editable details about the specific trigger for a webhook, including the following information:
ID: The Payrix Pro platform-generated ID number associated with the webhook trigger.
Created: The date that the webhook action was created.
Resource: The resource associated with the trigger.
Status: The status of the webhook: Active or Inactive.
Event: The event that activates the trigger.
Name: The name of the trigger.
Description: A description of the trigger.
Related pages
Click the links or items on the page to access any of the following pages: