How to Set Up Webhooks and Metadata Tracking for Your Organization

HopeGives allows organizations to receive real-time donation data through webhooks and track internal data points using custom metadata fields. This guide walks you through both features so your systems can stay in sync with activity on the platform.

Part 1: Webhook Setup

A webhook is a secure URL that allows your system to automatically receive donation events from HopeGives. When someone donates or receives a refund, we’ll instantly send a POST request to your webhook with all relevant details.

How to Configure Your Webhook

  1. Go to your Settings tab in the organization dashboard.

  2. In the Subscription section, enter your Webhook URL (must be HTTPS).

  3. Select the events you'd like to receive:

    • Donation Succeeded

    • Donation Refunded

  4. Click Save to enable the webhook
Screenshot 2025-05-28 at 9.40.51 AM

 

Tip: You can disable or update the webhook at any time by returning to this section.


 

Part 2: Custom Metadata Fields

HopeGives supports up to 6 custom metadata fields that allow you to collect and track specific information about missionaries when they onboard with your organization. These fields are included in webhook payloads, making it easy to match donations to your internal records.

How to Configure Metadata Fields

  1. In the Organization Metadata section, click to expand any of the six available slots.

  2. Customize each field:

    • Label: Displayed to the missionary (Example, "Missionary Account ID")

    • Payload Name: Key used in webhook data (e.g., metadata1)

    • Tooltip (Optional): Help text to guide users (e.g., "This is the ID you are issued when commissioned")

    • Help Link (Optional): Link to additional guidance or documents

  3. Toggle Is Enabled to activate the field.

  4. Click Save to confirm.

Screenshot 2025-05-28 at 9.44.42 AM

    Enabled fields will be shown during missionary onboarding and their values will be tied to all campaign activity for that missionary.


     

    Best Practices

    • Use HTTPS for your webhook URL.

    • Validate incoming requests with a token or signature (coming soon).

    • Clearly label metadata fields to reduce onboarding errors.

    • Only enable fields you plan to use.

    • Test your webhook endpoint with sample data before going live.

    Need help getting your webhook endpoint set up or planning your metadata structure? Contact Support