Skip to main content

Webhook

Use ORQO's built-in Webhook app to integrate with any HTTP-capable system. The Webhook app uses the DirectAdapter (no external adapter container) and supports both sending and receiving HTTP requests.

CategoryIntegration
CapabilitiesSend + Receive
AdapterDirectAdapter (built-in, no adapter URL needed)
Auth methodNone required (optional signature verification)

Prerequisites

  • An external system that can send or receive HTTP requests
  • Access to the ORQO Settings area

Setup

1. Install the Webhook App in ORQO

  1. Navigate to Settings > Apps in ORQO.
  2. Find Webhook in the app catalog and click Install.
  3. The app is created with the DirectAdapter — no adapter URL is needed.

Alternatively, create a custom app manually:

  1. Navigate to Settings > Apps and click New App.
  2. Name it (e.g., "Custom Webhook" or "CI Pipeline").
  3. Set capabilities to Send, Receive, or both.
  4. Leave the Adapter URL blank — ORQO uses the built-in DirectAdapter.

2. Configure Inbound Webhooks (Receive)

Your app's webhook endpoint is:

POST https://your-orqo-domain.com/api/v1/webhooks/:app_id

Replace :app_id with the App ID shown on the app card.

Configure your external system to send HTTP POST requests to this URL with a JSON payload:

{
"workflow_id": 15,
"task": "Process the incoming event",
"metadata": {
"source": "external-system",
"event_type": "new_order"
}
}

3. Secure the Webhook (Optional)

For production use, add signature verification:

  1. Add a signing secret credential to the app.
  2. Configure the signature header and algorithm.
  3. Sign outbound requests from your external system with HMAC:
PAYLOAD='{"workflow_id": 15, "task": "Process this"}'
SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "$SECRET" | cut -d' ' -f2)

curl -X POST https://your-orqo-domain.com/api/v1/webhooks/42 \
-H "Content-Type: application/json" \
-H "X-Signature-256: sha256=$SIGNATURE" \
-d "$PAYLOAD"
tip

Always use signature verification in production. Without it, anyone who discovers your webhook URL can trigger workflow runs.

4. Verify the Connection

Click Verify on the Webhook app card in ORQO. Send a test request to the webhook URL and confirm ORQO receives it.

Available Tools

The Webhook app exposes a general-purpose HTTP tool:

ToolDescription
http_requestMake an HTTP request to any URL (GET, POST, PUT, DELETE)

This tool can be assigned to agents via Skills, allowing them to call external APIs as part of workflow execution.

Platform-Specific Behavior

  • DirectAdapter — Unlike other integrations, the Webhook app does not use an external adapter container. ORQO handles inbound and outbound HTTP directly.
  • Flexible payloads — Inbound webhooks accept any JSON payload. The payload is passed to the workflow or Doorkeeper as-is.
  • No contact requirement for API triggers — When using webhooks purely for API triggering (not messaging), the Contact restriction does not apply. See Use the API for details.
  • Workflow triggering — Inbound webhooks can specify a workflow_id to trigger a specific workflow, or omit it to route through Doorkeeper.

What's Next