Skip to content

Webhooks

Create Webhook Trigger
client.webhooks.createWebhookTrigger(WebhookCreateWebhookTriggerParams { agent_name, forward_path, name, 3 more } body, RequestOptionsoptions?): WebhookCreateWebhookTriggerResponse { agent_name, key_id, name, 4 more }
POST/agent_api_keys/webhook-trigger
ModelsExpand Collapse
WebhookCreateWebhookTriggerResponse { agent_name, key_id, name, 4 more }
agent_name: string

The agent the webhook drives.

key_id: string

The created agent API key id.

name: string

Signature-lookup key (repo full_name / api_app_id).

secret: string

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

source: "internal" | "external" | "github" | "slack"

Webhook source (github or slack).

One of the following:
"internal"
"external"
"github"
"slack"
webhook_path: string

The forward path to POST webhooks to.

webhook_url?: string | null

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