Skip to main content
POST
Set Webhook

Authorizations

Authorization
string
header
required

AgentLine API key. Get one via the email OTP flow (POST /v1/auth/otp then POST /v1/auth/verify). Pass as: Authorization: Bearer sk_live_...

Body

application/json

Body for POST /v1/webhooks (create or replace an agent's webhook).

url
string<uri>
required

HTTPS URL that will receive this agent's events as signed JSON POSTs. Setting this replaces any existing webhook for the agent.

Required string length: 1 - 2083
agent_id
string
required

ID of the agent whose events this webhook receives. Each agent may have at most one webhook.

secret
string | null

Optional HMAC signing secret. Auto-generated if omitted. Used to verify the signature header on delivered payloads.

signature_header
string | null

Header name for the HMAC-SHA256 signature of the raw body. Defaults to 'X-Webhook-Signature' (natively verified by Hermes, OpenClaw, and other agent platforms). Set to 'X-Hub-Signature-256' for GitHub-style verification, or any custom header name your platform expects. Omit to keep the existing value when updating.

Response

Successful Response

Returned on POST — exposes the full secret this one time.

agent_id
string
required

Agent this webhook is scoped to

url
string
required

Configured webhook URL

secret
string
required

Full signing secret. Save it now — it is masked on subsequent reads.

signature_header
string
required

Header name used for HMAC-SHA256 signature delivery.

created_at
string<date-time> | null

When the webhook was last (re)configured