Webhooks are automated HTTP POST requests that Swipe Aras sends to a URL you control whenever a specific event occurs on your account. They allow your systems to react to events in real time — without polling the API.
When to Use Webhooks
Receive instant notification when a payment is authorized or refused
Get alerted when a dispute is filed
Track onboarding status changes automatically
Trigger fulfillment or accounting workflows without manual checking
How Webhooks Work
You register a webhook endpoint (a URL on your server) in the Swipe Aras dashboard
When an event occurs, Swipe Aras sends an HTTP POST to your endpoint with a JSON payload
Your server processes the payload and returns a
200 OKresponseIf your server doesn't respond with 200, Swipe Aras retries delivery (see Retry Policy & Delivery)
Webhook vs. API Polling
Approach | When to Use |
|---|---|
Webhooks | Real-time events — you want to know the moment something happens |
API polling | On-demand lookups — you need to query a specific record at a specific time |
For most integrations, webhooks are the recommended approach for staying in sync with your Swipe Aras account.
Requirements: Your endpoint must be accessible over HTTPS (HTTP is not accepted). See Setting Up a Webhook Endpoint for setup steps.