Animal rescue
Friendly people answer your questions quickly, by phone, chat or email. Our annual report is independently audited and published in full.
Overview
Local partners know their communities and make sure help arrives where it matters. We have helped more than two hundred thousand people since we started. Leave a gift in your will and help future generations.
Installation
Install the SDK with the package manager your project already uses. It needs Node 18 or newer.
$ npm install @rallyium/sdk$ yarn add @rallyium/sdk$ pnpm add @rallyium/sdkConfiguration
Clean water wells are built with and maintained by local communities. You receive photos and updates showing exactly what your donation achieved. Create a file named rallyium.config.json in the project root:
{
"project": "rallyium",
"region": "eu-west",
"categories": ["education", "health", "environment"],
"retries": 5,
"timeoutMs": 12000,
"webhooks": { "enabled": true }
}| Option | Type | Default | Description |
|---|---|---|---|
project | string | - | Your project key from the dashboard. |
region | string | "us-east" | Data centre closest to your donors. |
retries | number | 3 | How often a failed call is retried. |
timeoutMs | number | 10000 | Time before a request is cancelled. |
webhooks.enabled | boolean | false | Send events to your endpoint. |
Your first request
Thousands of donors already trust us, and we work hard to keep it that way.
- Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
- Store it safelyKeep the key in an environment variable, never in your source code.
- Make the callRun the snippet below; it prints the first page of results.
import { Client } from "@rallyium/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);
}API reference
Every endpoint returns JSON and uses standard HTTP status codes.
/v1/campaignsList campaigns with paging and filters./v1/campaignsCreate a new campaign./v1/campaigns/{id}Update some fields of a campaign./v1/campaigns/{id}Archive a campaign; it can be restored for 30 days.{
"data": [
{ "id": "campaign_9579", "name": "Shelter support", "price": 158 }
],
"has_more": true
}Troubleshooting
Next steps
Every donation is tax-deductible, and receipts arrive by email instantly.