Update a webhook

Update a webhook’s URL, events, description, or disabled state.

PATCH /api/v2/webhooks/{webhook_id}

Python

from hai_agents import Client

client = Client()

webhook = client.webhooks.update_webhook(
    webhook_id=webhook_id,
    disabled=True,
)
print(webhook.disabled)

Behavior

Only the fields you send change. To change the signing secret, use Rotate secret.

Path parameters

webhook_id · string · required

The webhook’s id (UUID).

Request body

url · string

New target URL, up to 2048 characters. Must be https:// and publicly reachable. It is verified with a HEAD request before the change is saved, and the old URL is kept if verification fails.

enabled_events · string[]

Replacement list of event types, or ["*"] for the session.status_updated firehose.

description · string

New label, up to 255 characters.

disabled · boolean

Set true to pause deliveries without deleting the webhook. Setting false re-enables a webhook that was disabled automatically after repeated delivery failures.

Response

200 with the updated webhook object.

Python

from hai_agents import Client

client = Client()

webhook = client.webhooks.update_webhook(
    webhook_id=webhook_id,
    disabled=True,
)
print(webhook.disabled)

Errors

Status	Cause
400	The new URL does not resolve to a public address or could not be reached.
404	Not found, or not in your organization.
422	Body failed validation: non-https URL, empty or unknown enabled_events, or null for url, enabled_events, or disabled.