v2.4.1
🐙

Welcome to RaiseIt Developer Docs

Build powerful crowdfunding integrations, automate campaign management, and extend the RaiseIt platform with our RESTful API, SDKs, and webhooks.

â„šī¸
Base URL

All API requests should be made to: https://api.raiseit.com/v2/

RaiseIt's API is designed to be straightforward and predictable. It follows standard HTTP conventions, uses JSON for request/response payloads, and supports OAuth 2.0 and API key authentication for secure access to campaign data, backer information, and payment processing.

Quick Start

Get up and running with the RaiseIt API in three simple steps.

1. Install the SDK

bash
npm install @raiseit/sdk@latest

2. Initialize the Client

javascript
import { RaiseIt } from '@raiseit/sdk';

const raiseit = new RaiseIt({
  apiKey: process.env.RAISEIT_API_KEY,
  environment: 'production' // or 'sandbox'
});

3. Fetch Campaigns

javascript
const campaigns = await raiseit.campaigns.list({
  status: 'live',
  limit: 10,
  sort: 'created_at:desc'
});

console.log(campaigns.data);
// Returns an array of campaign objects

Authentication

RaiseIt supports two authentication methods: API Keys for server-side operations and OAuth 2.0 for user-authorized client-side applications.

Method Header Format Use Case
Bearer <token> Authorization: Bearer rk_live_... Server-to-server, background jobs
OAuth 2.0 Authorization: Bearer access_token User-facing apps, campaign management
âš ī¸
Security Notice

Never expose your secret API keys in client-side code or public repositories. Use environment variables and restrict key permissions to the minimum required scope.

Rate Limits

To ensure platform stability, API requests are rate-limited based on your account tier:

  • Free: 100 requests/minute
  • Pro: 1,000 requests/minute
  • Enterprise: Custom limits with dedicated support

Rate limit headers are included in every response:

http
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1704067200

Campaigns API

Manage crowdfunding campaigns programmatically. Create, update, publish, and track performance metrics.

Method Endpoint Description
GET /campaigns List all campaigns
POST /campaigns Create a new campaign
GET /campaigns/:id Retrieve campaign details
PUT /campaigns/:id Update campaign metadata
POST /campaigns/:id/publish Launch campaign publicly

Webhooks

Subscribe to real-time events on your campaigns. RaiseIt will send HTTP POST requests to your configured endpoint when events occur.

✅
Webhook Signature Verification

All webhook payloads are signed using HMAC-SHA256. Verify the X-RaiseIt-Signature header before processing.

Available Events

  • campaign.created - New campaign saved
  • campaign.published - Campaign goes live
  • pledge.created - New backer pledge
  • pledge.cancelled - Backer withdraws
  • goal.reached - Funding target met
  • payout.completed - Funds transferred to creator

Official SDKs

We provide first-party libraries for popular languages to speed up development:

package managers
# Node.js / JavaScript
npm install @raiseit/sdk

# Python
pip install raiseit

# Go
go get github.com/raiseit/go-sdk

# Ruby
gem install raiseit-ruby

Each SDK mirrors the REST API structure exactly, so everything you read here applies directly to the language of your choice.