API Reference
Full API reference documentation is coming soon. For webhook integration details or API access during the early access period, contact us at support@riloworks.com.
What This Section Will Cover
This section will document Rilo’s external API surface for developers integrating with the platform:- Webhook ingress — how to POST tasks to Rilo’s
/webhookendpoint, including payload format, required headers, and signature verification - Authentication — org-scoped API keys,
X-Signature+X-Timestampheaders, and HMAC-SHA256 request signing - Event types — task lifecycle events (created, planned, executing, completed, failed) and how to receive them
- Portal API — customer-facing REST API for org management, credential submission, and task history
OpenAPI Specification
The Portal API is defined in an OpenAPI 3.1 specification. You can access the machine-readable spec directly:- portal.yaml — Rilo Portal API (OpenAPI 3.1, v0.1.0)
In the Meantime
- For webhook ingress setup and Slack integration, see Connecting Tools.
- For security and authentication details, see Security & Privacy.