Overview
Enterprise Webhooks are designed to allow external systems to receive updates regarding payments, pledges, and scheduled payments. Integration involves setting up specific webhook endpoints where Donary will send information in JSON format upon certain events.
Integration
📄️ Customer System Configuration
The customer system configuration for Donary webhooks involves setting up a POST API endpoint to receive event notifications. When specific events such as successful payments, payment updates, pledges, and scheduled payments occur, Donary sends JSON payloads to the configured endpoint. If delivery fails, Donary retries three times before notifying the event user via email.
📄️ Donary Configuration
To integrate webhooks with Donary Enterprise, users need to set up endpoint URLs in Donary's configuration settings for each webhook. These URLs must match the ones configured in the customer system.
Webhooks
📄️ Charge Payment Webhook
After a successful payment request from a Donary device, Donary Enterprise will send the following payload
📄️ Void Payment Webhook
Upon a successful request from a Donary device to void a payment, Donary Enterprise will send the following payload to the endpoint configured in the PaymentStatusUpdateWebhookEndpoint setting. This endpoint must match the URL configured in the customer's system.
📄️ Pledge Webhook
After a successful request from a Donary device to create a new pledge, Donary Enterprise will send the following payload to the endpoint configured in the PledgeWebhookEndpoint setting. This endpoint must match the URL configured in the customer's system.
📄️ Schedule Payment Webhook
When a successful request from a Donary device to the schedule payment api, Donary Enterprise will send the following payload to the endpoint configured in the ScheduleWebhookEndpoint setting. This endpoint must match the URL configured in the customer's system.
Execution Process
If the first attempt fails, Donary will attempt to deliver webhooks up to three times. If all attempts fail, an email notification will be sent to the user’s email.