Skip to main content
The RCB Automation REST API gives you full programmatic control over your automation platform. You can create and manage workflows, configure triggers, connect integrations, and register webhooks — all without touching the dashboard. The API follows REST conventions and returns standard HTTP status codes alongside JSON-encoded responses.

​
Base URL

All API requests are made to the following base URL: 
https://api.rcbautomation.com/v1
Append the resource path to this URL for every request. For example, to list your workflows, send a GET request to https://api.rcbautomation.com/v1/workflows.

​
Content type

Every request body must be sent as JSON, and every response body is returned as JSON. Include the Content-Type header on all requests that have a body: 
Content-Type: application/json
If you omit this header on a request with a body, the API returns a 415 Unsupported Media Type error.

​
Authentication

All API requests require a valid API key. Pass your key in the Authorization header as a Bearer token: 
Authorization: Bearer YOUR_API_KEY
See the Authentication page for full details on generating keys, setting scopes, and handling auth errors.

​
Rate limits

The API enforces a default rate limit of 1,000 requests per minute per API key. When you exceed this limit, the API responds with 429 Too Many Requests. The response includes a Retry-After header indicating how many seconds to wait before retrying.
Enterprise plans include higher rate limits. Contact your account manager or RCB Automation support to request an increase.
Rate limit headers are included on every response:
HeaderDescription
X-RateLimit-LimitMaximum requests allowed per minute
X-RateLimit-RemainingRequests remaining in the current window
X-RateLimit-ResetUnix timestamp when the window resets

​
Versioning

The current API version is v1, reflected in the base URL path. RCB Automation follows a stability-first versioning policy:
  • Non-breaking additions (new optional fields, new endpoints) are introduced in v1 without a version bump.
  • Breaking changes are released as a new version (e.g., v2) with a minimum 90-day deprecation notice before v1 is retired.
  • Deprecation notices are communicated via email to account owners and in the changelog.
Always pin your integrations to a specific version path (/v1) rather than an unversioned path to avoid unexpected breakage.

​
Available resources

The API exposes four primary resource types:
ResourceDescription
WorkflowsAutomated processes that execute a sequence of actions
TriggersConditions that start a workflow run (schedule, webhook, app event, or manual)
IntegrationsConnected third-party apps that your workflows can read from and write to
WebhooksOutbound HTTP notifications sent when specific events occur in RCB Automation

​
HTTP methods

The API uses standard HTTP methods:
MethodUsage
GETRetrieve a resource or list of resources
POSTCreate a new resource
PUTUpdate an existing resource (partial updates are supported)
DELETEDelete a resource

​
Error responses

All errors return a JSON object with a code and message field: 
{
  "code": "validation_error",
  "message": "The 'name' field is required.",
  "details": {
    "field": "name"
  }
}
Common HTTP status codes:
StatusMeaning
200 OKRequest succeeded
201 CreatedResource created successfully
204 No ContentRequest succeeded with no response body (e.g., DELETE)
400 Bad RequestInvalid request body or parameters
401 UnauthorizedMissing or invalid API key
403 ForbiddenAPI key lacks permission for this action
404 Not FoundResource does not exist
429 Too Many RequestsRate limit exceeded
500 Internal Server ErrorUnexpected server error