---
title: "Set Up Webhooks"
slug: "set-up-webhooks"
updated: 2026-03-02T21:34:53Z
published: 2026-03-02T21:34:53Z
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://resource.payrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Up Webhooks

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.

> [!NOTE]
> Note
> 
> If you prefer to receive notifications by email rather than through webhook integrations, see [Set Up Email Alerts](/v1/docs/set-up-email-alerts) for guidance on setting up custom email alerts.

A webhook is made up of three parts:

1. **Webhook Details:** Defines which users and resources are monitored and includes the full configuration of triggers and actions.
2. **Webhook Triggers:** Specifies the events that activate the webhook.
3. **Webhook Actions:** Sets delivery options, including retry and format settings.

## Define Who Your Webhooks Monitor

When you create an webhook, you must define who it targets and monitors. Use 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]
> 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 webhook based on your needs.

To set up a webhook:

1. Under Admin in the left navigation panel, select **Webhooks**.
2. Click **ADD WEBHOOK** in the upper-right corner of the page to open the Create Webhook dialog.
3. Enter the name of the new webhook in the Name field in the first section of the Create Webhook dialog.
4. (Optional) Enter a description of the webhook in the Description field.
5. (Optional) Click **Advanced Options**to enter information about the login ID, Team, or Division associated with the webhook.

You can enter the optional advanced options during any step of the setup process.
6. Click **Next**in the lower-right corner of the dialog to move to the next section.
7. Enter the endpoint in the Endpoint field. The endpoint is the URL address on your server that receives the webhook from Payrix Pro.
8. (Optional) Enter the header name and header value in the open fields under the Endpoint field.
9. Click **Next**in the lower-right corner of the dialog to move to the next section.
10. Select a resource from the Resource dropdown menu.

Due to the number of resources available, this article does not provide a detailed breakdown of each one.
11. Select the type of event that triggers the webhook from the Event dropdown menu.
12. (Optional) Enter a name and description in the fields below the Resource and Event fields.
13. Click **Add**to finish setting up the new webhook.

Your webhook is active and automatically triggers when the specific event occurs.

## Add Webhook Actions

With your webhook triggers and actions set, you can add more delivery methods for receiving webhooks.

To add more Webhook Actions:

1. Select **Webhooks** from the left navigation panel.
2. Select the relevant webhook to open the **Webhook Details**page.
3. Click **Add Webhook Action**.
4. Provide the **Endpoint**, **Header Name**, and **Header Value**.
5. Click **Add**.

Webhooks are now delivered to multiple channels.

The process of adding clients (merchants) to the Payrix Pro platform to use the Payrix Pro payment solutions. Also known as *boarding*.

The web portal offered by the Payrix Pro platform to accomplish tasks for their business through a web-based user interface rather than the API. The Payrix Pro portal contains general settings, payment processing options, reporting, fee settings, group assignments, user management, and much more.

A unique configuration allowing user role resources to be set and applied to multiple users at once for access to and capabilities on different merchant accounts that can be saved to apply to future users.

The portfolio associated with a partner. Every merchant is associated with a partner Division, where workflows are set up to automatically add new merchants to groups. This is also where white-label settings are configured.

A PayFac-as-a-service platform. Software companies can act as payment facilitators without taking on the associated risks, compliance burdens, and investment.