Xenoara CoDocs
Dashboard

Animal rescue

You receive photos and updates showing exactly what your donation achieved. Start in minutes and get help from a real person whenever you need it.

5 min read Updated Sep 24, 2026 v3.4.8

Overview

Volunteers give their time in schools, shelters and food banks every week. Friendly people answer your questions quickly, by phone, chat or email. Our annual report is independently audited and published in full. Companies can match employee donations and double their impact.

Transparent reportsWe have helped more than two hundred thousand people since we started.Tax receiptsLocal partners know their communities and make sure help arrives where it matters.Local partnersEvery donation is tax-deductible, and receipts arrive by email instantly.

Installation

Install the SDK with the package manager your project already uses. It needs Node 18 or newer.

terminal
$ npm install @xenoara-co/sdk
terminal
$ yarn add @xenoara-co/sdk
terminal
$ pnpm add @xenoara-co/sdk
Using a server without Node? The same endpoints are available over plain HTTPS; see the API reference below.

Configuration

Every detail is handled by people who care about getting it right. Our team has done this many times, so you never have to guess. Create a file named xenoara-co.config.json in the project root:

xenoara-co.config.json
{
  "project": "xenoara-co",
  "region": "us-east",
  "categories": ["education", "health", "environment"],
  "retries": 2,
  "timeoutMs": 3000,
  "webhooks": { "enabled": true }
}
OptionTypeDefaultDescription
projectstring-Your project key from the dashboard.
regionstring"us-east"Data centre closest to your donors.
retriesnumber3How often a failed call is retried.
timeoutMsnumber10000Time before a request is cancelled.
webhooks.enabledbooleanfalseSend events to your endpoint.

Your first request

We listen first, then build a plan around what you actually need.

  1. Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
  2. Store it safelyKeep the key in an environment variable, never in your source code.
  3. Make the callRun the snippet below; it prints the first page of results.
index.js
import { Client } from "@xenoara-co/sdk";

const client = new Client({ apiKey: process.env.API_KEY });

// list the newest campaigns in one category
const page = await client.campaigns.list({ category: "education", limit: 20 });

for (const item of page.data) {
  console.log(item.name, item.price);
}
Heads up: test keys only return sample data. Switch to a live key before you go to production.

API reference

Every endpoint returns JSON and uses standard HTTP status codes.

GET/v1/campaignsList campaigns with paging and filters.
POST/v1/campaignsCreate a new campaign.
PATCH/v1/campaigns/{id}Update some fields of a campaign.
DELETE/v1/campaigns/{id}Archive a campaign; it can be restored for 30 days.
response.json
{
  "data": [
    { "id": "campaign_8226", "name": "Emergency fund", "price": 291 }
  ],
  "has_more": true
}

Troubleshooting

Leave a gift in your will and help future generations. We keep things simple, so you can focus on what matters to you.

Ninety cents of every dollar goes directly to the projects you support. A school kit costs less than a cinema ticket and lasts a whole year.

Friendly people answer your questions quickly, by phone, chat or email. Companies can match employee donations and double their impact.

Next steps

Ninety cents of every dollar goes directly to the projects you support.

Was this page helpful?
All screens