Agents API: webhooks

Create a webhook; the response carries its signing secret once

post/api/v1/webhooks

Request

  • Base URL: https://three.ws
  • URL: https://three.ws/api/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

Idempotency-Keystring

A retry with the same key and body replays the stored response for 24 hours.

Request body

urlstring uri required

HTTPS endpoint that receives events.

eventsstring[]

Event types from GET /api/v1/webhooks/events. Empty means all.

agentIdstring uuid

Limit the endpoint to one agent. Account events are then unavailable.

descriptionstring

Free text shown in the dashboard.

Response

The { data, meta: { requestId, timestamp } } envelope.

Changes

No recorded changes to this operation across all 1 revision of this API.