Skip to content
RelayDocumentation

API ReferenceOverview

API reference

The Relay REST API: base URL, authentication, request format and versioning.

The Relay API is organized around REST. It accepts JSON request bodies, returns JSON responses and uses standard HTTP status codes and verbs.

https://api.relay.dev/v1

Authentication

Send your secret key as a bearer token. See Authentication for test and live keys and permissions.

curl https://api.relay.dev/v1/endpoints \
  -H "Authorization: Bearer rk_test_51Hx9a2f7c1d"

Requests and responses

  • Send bodies as JSON with Content-Type: application/json.
  • Timestamps are ISO 8601 strings in UTC, like 2026-10-14T09:31:12Z.
  • IDs are prefixed by type: evt_ for events, ep_ for endpoints, dlv_ for deliveries.
  • Every response has a Request-Id header. Include it when you contact support.

Versioning

The current version is v1. We never make breaking changes to v1: we only add new endpoints, optional parameters and response fields. Your code should ignore fields it doesn't know.

Resources