RippleDocs
Open Ripple

Ripple API

API reference

Every operation the Ripple API publishes, with its fields, its responses and code to copy.

Requests

Base URL
https://api.ripplepush.com
Format
JSON in and out. A send can also be plain text.
Keys
A send key or API token, sent as Authorization: Bearer.
Errors
Every error has a code to match on and a message for people.
Paging
Send a list’s nextCursor back as cursor to get the next page.

Authentication

  • Send key

    A source's send key, from that source's settings in Ripple. It can only send, and only to its source.

  • Key in the address

    The send key as ?key= in the address, for tools that only let you set a URL. Only POST /v1/send accepts it, and it never takes an API token.

  • API token

    An API token, made in Ripple under Settings > Developer > API tokens. A full-access token can use every operation in this reference on your account, including permanent deletion. A read-only token can only list, read and search; anything else returns 403 read_only_token. Send it in the Authorization header, never in the address.

Keys and tokens explains which to use.

Operations

Send

Post a message with a send key or an API token.

Messages

List, read, search, organize and snooze messages and threads.

Sources

Create sources, change their settings and manage their send keys.

Trash

See what was deleted, restore it or delete it for good.