v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0189112274.5 KB

Agent APIKeys

Create Webhook Trigger

Wire a webhook trigger in one call.

Registers the source's signature-verification key (github/slack) for the agent and returns the ready-to-paste forward webhook URL plus the signing secret (shown once). The webhook then flows through the existing /agents/forward ingress, which verifies the signature against this key. Bundles the existing key-create + URL composition so a UI (or a curl) can set up a trigger without two steps.

post/agent_api_keys/webhook-trigger

Request body

agent_namestring required

The agent the webhook drives.

source'internal' | 'external' | 'github' | 'slack'

namestring required

Signature-lookup key: the repo full_name (github) or api_app_id (slack) that the forward ingress matches the incoming webhook against.

forward_pathstring required

Subpath the agent's own route handles, e.g. 'github-pr/<config-id>'. Appended to /agents/forward/name/{agent_name}/ to form the webhook URL.

secretstring nullable

Signing secret. For GitHub, omit to generate one, or provide an existing webhook secret. For Slack, this is required and must be the Slack app's Signing Secret.

base_urlstring nullable

Optional public agentex base URL for the returned webhook_url; defaults to the AGENTEX_PUBLIC_URL env var.

Response

Successful Response

key_idstring required

The created agent API key id.

agent_namestring required

The agent the webhook drives.

source'internal' | 'external' | 'github' | 'slack' required

namestring required

Signature-lookup key (repo full_name / api_app_id).

secretstring required

The signing secret — shown once; paste into the source's webhook config.

webhook_pathstring required

The forward path to POST webhooks to.

webhook_urlstring nullable

Full webhook URL to paste into the source (None if no base URL configured).