Status and versioning

The current version is v1 (document version 1.1.0). Every path starts with https://rallytext.app/api/v1.

What can change in v1

Within v1 we only add things: new endpoints, new optional request fields, new response fields, new error codes and new webhook events. Write your code to ignore fields and events it doesn't know about. Every change is listed in the changelog.

Breaking changes

Removing or renaming a field or endpoint, or changing what one means, would ship as a new version at /api/v2. v1 keeps working for at least 90 days after v2 is announced. We announce it in the changelog and by email to the head coaches and team directors of teams with active API keys.

Security fixes

Security fixes can ship at any time, without notice, even when they change how an endpoint behaves. For example, we may start refusing a request that was accepted before. We list them in the changelog afterwards.

Service status

Live status is on the status page. The API runs on the same servers as the dashboard, so it is covered by "Website & Dashboard". Texts sent through the API are covered by "SMS Sending", and webhook events for incoming texts by "Inbound Message Processing". If a request fails with server_error, retry with a short wait. For anything else, email support@rallytext.app.