A webhook is a notification sent from the Payrix Pro API to your server when a specific event occurs in your portfolio. For example, you can set up a webhook to notify your server when a new merchant’s onboarding status changes from Not Ready to Boarded to indicate the merchant is approved to process payments.
A webhook is made up of three parts:
Webhook: Defines which users and resources are monitored and includes the full configuration of triggers and actions.
Webhook Trigger: Specifies the events that activate the webhook.
Webhook Action: Sets delivery options (email, SMS, or webhook), including retry and format settings.
The following sections explain how to configure each part. For step-by-step setup instructions for specific events, see Use Cases: Alerts.
Webhook Outbound IP Address
In our commitment to ensuring secure and compliant systems, we frequently receive inquiries concerning the IP addresses associated with the origin of outbound messages. Being aware of these IP addresses is crucial for ensuring a smooth experience while using our platform.
To assist you effectively, we have assembled the latest list of our outbound IP addresses that are specifically designed for sending webhooks:
Production environment IP addresses: 3.219.99.73 and 3.209.223.102
Sandbox environment IP address: 34.224.195.65
Define Who Your Webhooks Monitor
When you create a webhook, you must define who the webhook targets and monitors. Enter your Login ID, or another applicable Login ID, to indicate ownership. If you do not provide a Login ID, the Payrix Pro Portal defaults to ID of the user setting up the webhook.
Then, choose one of the following to set the monitoring scope:
For Login: Monitors a specific user’s activities.
Team: Monitors all users within a Team.
Division: Monitors all users within a Division.
Note
Only one monitoring scope can be set per webhook. A Login ID is always required, but only identifies the webhook owner, not the monitored user or users.
By default, the Division field is auto-filled, but can be removed and replaced by entering an ID for the Team or For Login fields.
Set Up a Webhook
You can use the Payrix Pro portal to configure different webhooks based on your needs.
To set up a webhook:
Select Webhooks from the left navigation panel.
Click Add Webhook.
(Optional) Enter the Name and Description for the webhook.
Enter your Login ID (or the Login ID of the user that owns this webhook).
Set the scope using one ID: For Login, Team, or Division.
Click Next.
Enter your Endpoint (such as webhook.site or a mobile service).
Enter the required Header Name and Header Value.
Click Next
Select a Resource and Event that triggers the webhook.
Click Add.
Result: Your webhook is active and triggers when the selected event occurs for the target.
Add Webhook Triggers
After setting up your webhook, you can also add more event triggers to the same webhook.
To add more Webhook Triggers:
Select Webhooks from the left navigation panel.
Select the relevant webhook to open the Webhook Details page.
Click Add Webhook Trigger.
Select another Resource and Event value.
(Optional) Add a Name and Description for the Action Trigger.
Click Add.
Result: Your additional conditions now activate the webhook.
Add Webhook Actions
With your triggers and webhooks set, you can add more delivery methods for receiving webhooks.
To add more Webhook Actions:
Select Webhooks from the left navigation panel.
Select the relevant webhook to open the Webhook Details page.
Click Add Webhook Action.
Provide the Endpoint, Header Name, and Header Value.
Click Add.
Result: Webhooks are now delivered to multiple channels.