Webhooks

A webhook is an HTTP request Baiyar sends to a URL you configure whenever something happens on your project — a payment reaching a final state, a project’s settings changing, or an API key being created or revoked. Use it instead of polling GET /v1/payments/{paymentID} to know the moment a customer completes payment.

Webhooks apply the same way to both payment links and direct payments — the payment lifecycle behind them is identical either way.

Where to go from here

• Quickstart — configure a URL, verify a signature, and trigger a test event, in that order.
• About
  • How Webhooks Work — the concept, and what happens between a payment finishing and your endpoint being called.
  • Configure a Webhook — set the URL and get your signing secret from the dashboard.
  • Handling Webhook Deliveries — responding correctly, retries, and idempotency.
  • Verifying Webhook Signatures — confirm a request genuinely came from Baiyar before you act on it.
• Transaction — payment.paid and payment.failed, sent when a transaction reaches a final state.
• Payment Attempt — payment_attempt.created, sent when a new try to pay a transaction is created.
• Payment Link — payment_link.created and payment_link.cancelled.
• Project — project.updated, project.activated / project.deactivated, project.webhook_configured / project.webhook_removed, and project.review_submitted.
• API Key — apikey.created and apikey.deleted, sent when a key is created or revoked.