Files
paperclip/docs/adapters/http.md
Dotta 09d2ef1a37 fix: restore docs deleted in v0.2.3 release, add Paperclip branding
- Restored docs/ directory that was accidentally deleted by `git add -A`
  in the v0.2.3 release script
- Replaced generic "P" favicon with actual paperclip icon using brand
  primary color (#2563EB)
- Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark)
- Updated docs.json with logo configuration for dark/light mode
- Fixed release.sh to stage only release-related files instead of `git add -A`
  to prevent sweeping unrelated changes into release commits

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-03 15:49:43 -06:00

1.4 KiB

title, summary
title summary
HTTP Adapter HTTP webhook 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

  • 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

  • If the agent runs locally on the same machine (use process, claude_local, or codex_local)
  • If you need stdout capture and real-time run viewing

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

  1. Paperclip sends a POST request to the configured URL
  2. The request body includes the execution context (agent ID, task info, wake reason)
  3. The external agent processes the request and calls back to the Paperclip API
  4. Response from the webhook is captured as the run result

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.