Webhook Configuration

To integrate webhooks for Donary Enterprise, POST API endpoints need to be configured in your primary system to receive notifications for successful payments, voided payments, pledges, and scheduled payments. After setting up these endpoints, please email Donary to complete the webhook integration.

Step-by-Step Configuration

---

1. Configure API Endpoints for Webhooks

   Set up POST API endpoints in your system for each of the following events:

   Payment Webhook: Notifications for successful payments.

   Void Payment Webhook: Notifications for voided payments.

   Pledge Webhook: Notifications for pledges.

   Scheduled Payment Webhook: Notifications for scheduled payments.

   Scheduled payment integrations may also use the ScheduleHandlingMode setting to control whether schedule details are handled by the integration, by Donary, or by Banquest. The schedule webhook endpoint itself is configured with ScheduleWebhookEndpoint.

   Each endpoint must:

   Be accessible anonymously, without requiring an authentication token.

   Handle the JSON payloads sent by Donary for the respective events.

2. Email Donary to Finalize Configuration

   After configuring the required endpoints in your system, please email Donary at integrations@donary.com with the details of each URL and any requested schedule handling mode. Donary will then configure these URLs in the system to match the ones you’ve provided for the following settings:

   Add Payment Webhook

   Setting: PaymentWebhookEndpoint

   Void Payment Webhook

   Setting: PaymentStatusUpdateWebhookEndpoint

   Pledge Webhook

   Setting: PledgeWebhookEndpoint

   Schedule Payment Webhook

   Setting: ScheduleWebhookEndpoint

   Optional setting: ScheduleHandlingMode

   Available modes: Integration, Donary, Banquest

3. Execution

   Donary will send JSON payloads to the configured endpoint. If delivery fails, Donary retries three times before notifying the user via email.