HTTP Adapter
The http adapter sends a webhook request to an external agent service. The agent runs externally and Paperclip just triggers it.
When to Use
Section titled “When to Use”- Agent runs as an external service (cloud function, dedicated server)
- Fire-and-forget invocation model
- Integration with third-party agent platforms
When Not to Use
Section titled “When Not to Use”- If the agent runs locally on the same machine (use
process,claude_local, orcodex_local) - If you need stdout capture and real-time run viewing
Configuration
Section titled “Configuration”| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Webhook URL to POST to |
headers | object | No | Additional HTTP headers |
timeoutSec | number | No | Request timeout |
How It Works
Section titled “How It Works”- Paperclip sends a POST request to the configured URL
- The request body includes the execution context (agent ID, task info, wake reason)
- The external agent processes the request and calls back to the Paperclip API
- Response from the webhook is captured as the run result
Request Body
Section titled “Request Body”The webhook receives a JSON payload with:
{ "runId": "...", "agentId": "...", "companyId": "...", "context": { "taskId": "...", "wakeReason": "...", "commentId": "..." }}The external agent uses PAPERCLIP_API_URL and an API key to call back to Paperclip.