Skip to main content
Enable Webhooks

Receive real-time data from WinRed transactions

Updated over a week ago

Webhooks are the best way to receive real-time data from WinRed transactions. They are completely customizable based on the data you require. Webhooks are configurable for different data points and types. Follow the steps below to set up your Webhook.

Types of Webhooks

WinRed offers two types of Webhooks.

A Recipient Webhook, which will deliver event-level data that is directed to your organization.

The second type is an Origin Webhook, delivering event-level data that is coming from your organization.

Set up the Webhook

โ€‹To get started, head to the Utilities tab and click the Integrations tab from the sub-menu. Click the green Add Integration button and select Webhook from the menu.

Once selected, give the Webhook a name and add some notes about what the Webhook is.

Add an Endpoint URL, which is the valid endpoint from the service you would like to send data to.

Select what type of event the Webhook should include. There are three options to choose from:

  • Donation Webhooks

  • Lead Webhooks

  • Subscription Webhooks

Donation Webhooks

If a Donation Webhook is selected, choose which event will trigger the webhook and add any specific donation filters such as amount, campaign, and contributor type.

Select one of the available predicates listed below for the amount filter. The campaign and contributor type will only have one predicate, which is equals.

  • less than

  • less than equal to

  • greater than

  • greater than equal to

  • equal to

Enter a value for the amount filter or select an existing campaign for the campaign filter. Choose personal, business, or PAC for the contributor filter.

Note: WinRed Webhooks use "OR" logic for the campaign filter. Every other donation filter will use "AND" logic.

Lead Webhooks

If a Leads Webhook is selected, a new lead will trigger an event, and specific filters, such as number, page UID, and source, can be added.

The predicate for the number filter is present, and no value has to be entered.

The predicate for the page UID filter is equals. Then, enter a page UID for the value, which will begin with rv_page_.

The predicate for the source filter is equals, and select petition, abandoned cart, or volunteer as the value.

There is no limit to how many lead filters can be added here.

Subscription Webhooks

If a Subscription Webhook is selected, a new subscription will trigger an event, and there are no specific filters.

Complete the Setup

Once the type of webhooks and its filters are selected, the JSON payload that is sent with three types of Webhooks can be customized.

Add any custom fields to the JSON payload by hitting the green add Custom JSON fields button.

Add a static JSON field to your webhook if you are planning on tracking it.

Lastly, set the Integration Status to Active or Inactive. If you toggle to Active, it will set the Webhook live.

Once done, click Save!

Available Data and Field Types

Questions? Our team is here to help! Click on the red chat box at the bottom right corner of your screen, and a member of our team will assist!

Did this answer your question?