Skip to content

Recipes

The Resources page lists what’s available; this page shows how the pieces fit together. Each recipe is a self-contained walk-through — a sequence of API calls that accomplishes one common integrator goal, with the request/response shapes the Live API explorer can’t capture: order, intent, and the exact field combinations that matter.

  • Import a contact — create a contact with one phone, one email, and one address; round-trip the resulting id.
  • Record a donation — post a donation via POST /orders with a Cash payment; show how auto-batch attaches the order to a daily batch.
  • Charge a card — the realistic flow with a tokenized payment method, a real processor charge, and proper error handling.
  • Run a saved report — paginate through a saved report’s results, then export the same report to Excel.
  • Listen for events — register a webhook endpoint, store the secret, verify the signature, and respond inside the timeout.

Every recipe assumes you have:

  • An API key and a tenant id (see Getting started).

  • The two environment variables exported:

    Terminal window
    export AURA_API_KEY="ak_live_..."
    export TENANT_ID="00000000-0000-0000-0000-000000000000"
  • A working understanding of the error envelope and pagination shape.

curl is the canonical sample on every recipe. Where a typed example makes the flow clearer, a single C# HttpClient snippet appears alongside.

Email [email protected] with the workflow you’re trying to build. Recipes are added when integrators ask for them — the goal is to cover the patterns real customers want, not to enumerate every theoretical sequence.