WebhooksOverview

Overview

Set Up Webhooks

Webhooks are event-driven HTTP callbacks that allow Apara to deliver real-time updates to your application when payment events occur — eliminating the need to poll the API.

Apara transmits webhook events as HTTP POST requests with JSON payloads.

What You Need

An HTTPS endpoint on your server that:

  • Accepts POST requests
  • Returns HTTP 200 OK promptly
  • Processes events asynchronously

Setup

Configure your webhook URL under Dashboard → Settings → Webhooks.

Set separate webhook URLs for Sandbox and Production.

Webhook Guides

  • Webhook Schema - structure of the JSON payload
  • Responding to Webhooks - acknowledgment and best practices
  • Webhook Signature - verifying requests are from Apara
  • Webhook Retry - how Apara retries failed deliveries
  • Webhook Events - full list of event types