RallyiumDocs
Dashboard

Animal rescue

Friendly people answer your questions quickly, by phone, chat or email. Our annual report is independently audited and published in full.

10 min read Updated May 22, 2026 v2.6.12

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.

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

Configuration

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:

rallyium.config.json
{
  "project": "rallyium",
  "region": "eu-west",
  "categories": ["education", "health", "environment"],
  "retries": 5,
  "timeoutMs": 12000,
  "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

Thousands of donors already trust us, and we work hard to keep it that way.

  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 "@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);
}
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_9579", "name": "Shelter support", "price": 158 }
  ],
  "has_more": true
}

Troubleshooting

Ninety cents of every dollar goes directly to the projects you support. We measure success by how many donors come back and tell their friends.

We listen first, then build a plan around what you actually need. Every donation is tax-deductible, and receipts arrive by email instantly.

Our team has done this many times, so you never have to guess. Clear prices, honest advice and no surprises along the way.

Next steps

Every donation is tax-deductible, and receipts arrive by email instantly.

Was this page helpful?
All screens