API

ORQO provides an API for programmatic access. Use it to trigger workflows, receive callbacks, and integrate ORQO into your automation pipelines.

Authentication

API requests are authenticated using API tokens. Generate a token from Settings → API Tokens in the dashboard.

Include the token in the Authorization header:

Authorization: Bearer your-api-token

Trigger a Workflow (Authenticated)

Start a workflow run programmatically using an API token:

POST /api/v1/trigger
Content-Type: application/json
Authorization: Bearer your-api-token

{
  "workflow_id": 42,
  "input": "Process the latest customer feedback data"
}

This creates a new workflow run and returns the run ID. The workflow executes asynchronously.

Webhook Trigger Endpoint (Token-Based)

Webhook triggers provide a simpler alternative when you want a dedicated URL for a specific workflow. No API key is needed -- the URL itself contains a unique token that authenticates the request.

POST /api/v1/hooks/:token
Content-Type: application/json

{
  "event": "push",
  "branch": "main"
}

Response (201 Created):

{
  "workflow_run_id": 42,
  "status": "started"
}

The request body is passed to the workflow as its initial input. Create webhook triggers from the Runs & Triggers tab on any workflow -- ORQO generates the token and displays the full URL.

Status	Meaning
201 Created	Workflow run started
404 Not Found	Invalid or unknown token
409 Conflict	Trigger is disabled
422 Unprocessable Entity	Workflow failed to start

See Reference: Triggers for full details on webhook triggers.

When to Use Which

Approach	Use case
POST /api/v1/trigger (API token)	You need to trigger any workflow by ID, from a trusted system that holds your API key
POST /api/v1/hooks/:token (webhook)	You want a dedicated URL for one workflow, shareable with external services like GitHub, Zapier, or CI/CD

Callbacks

When a workflow run completes, ORQO can notify your system via a callback:

POST /api/v1/callback

Configure callback URLs on your workflow or trigger to receive notifications when runs complete, fail, or produce output.

Use Cases

• CI/CD integration -- Trigger a review workflow when a PR is opened, using a webhook URL or the API.
• Monitoring -- Kick off an analysis workflow when an alert fires.
• Scheduled automation -- Use an external scheduler to trigger workflows with dynamic input.
• Chaining -- One workflow's output triggers another workflow via the API.
• Third-party integrations -- Give Zapier, GitHub, or Slack a webhook URL to fire workflows on external events.

note

A full OpenAPI specification is planned. The Redocusaurus integration is pre-configured and will be enabled when the spec is ready.