Webhooks Overview

Beta

Webhooks deliver real-time events from Orvion to your application. They enable you to react to events as they happen, without polling the API.

What are Webhooks?

Webhooks are HTTP callbacks that:

  • Deliver events: Send events to your application in real-time
  • Reduce polling: No need to poll the API for updates
  • Enable automation: Trigger actions based on events
  • Improve UX: Update your UI immediately when events occur

How Webhooks Work

  1. Event occurs: Invoice paid, payment completed, etc.
  2. Orvion sends webhook: HTTP POST to your endpoint
  3. Your app processes: Handle the event in your application
  4. Response sent: Return 200 OK to acknowledge receipt

Webhook Security

Webhooks are signed to ensure authenticity:

  • Signature header: X-Orvion-Signature contains the signature
  • Verification: Verify signatures before processing events
  • Replay protection: Check event IDs to prevent replay attacks

Webhook Configuration

Configure webhooks via:

  • Dashboard: Settings → Webhooks
  • API: (Coming soon)

Each webhook requires:

  • URL: Endpoint to receive events
  • Events: Which events to subscribe to
  • Secret: Secret for signature verification

Event Types

Invoice Events

  • invoice.created - Invoice was created
  • invoice.sent - Invoice was sent to customer
  • invoice.paid - Invoice was marked as paid
  • invoice.overdue - Invoice became overdue

Payment Events

  • payment.created - Payment was initiated
  • payment.completed - Payment was completed
  • payment.failed - Payment failed

Retry Logic

If your endpoint returns an error:

  • Retry attempts: Up to 3 retries
  • Exponential backoff: Delays increase between retries
  • Dead letter queue: Failed events are stored for manual processing

Related Documentation