Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/dallay/corvus/llms.txt

Use this file to discover all available pages before exploring further.

​
corvus gateway

Start the webhook server for HTTP-based integrations.

​
Usage

corvus gateway [OPTIONS]

​
Default Binding

corvus gateway
Starts on 127.0.0.1:8080 (localhost only).

​
Options

​
-p, --port
u16
Port to listen on. Use 0 for random available port.
​
--host
string
default:"127.0.0.1"
Host to bind to. Defaults to config gateway.host.

​
Examples

​
Custom Port

corvus gateway --port 3000

​
Random Port (Security Hardened)

corvus gateway --port 0
Output: 
🚀 Starting Corvus Gateway on 127.0.0.1:54321 (random port)

​
Public Binding (with Tunnel)

corvus gateway --host 0.0.0.0 --port 8080
Never expose 0.0.0.0 without a tunnel or allow_public_bind = true in config.

​
Endpoints

EndpointMethodAuthDescription
/healthGETNoneHealth check
/pairPOSTX-Pairing-CodeExchange pairing code
/webhookPOSTBearer tokenSend message
/whatsappGETQuery paramsWhatsApp verification
/whatsappPOSTMeta signatureWhatsApp webhook

​
Pairing Flow

  1. Start gateway
  2. Note the 6-digit pairing code in logs
  3. Exchange code for token:
curl -X POST http://localhost:8080/pair \
  -H "X-Pairing-Code: 123456"
Response: 
{"token": "eyJ0eXAiOi..."}
  1. Use token for webhook requests:
curl -X POST http://localhost:8080/webhook \
  -H "Authorization: Bearer eyJ0eXAiOi..." \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello, Corvus!"}'

Build docs developers (and LLMs) love

Get started for freeTalk to us