Users

users_webhooks_update

Change a webhook endpoint: its url, its subscribed events, its description, or `active` to pause and resume delivery without losing the endpoint or its secret.

Tool

users_webhooks_update

Change a webhook endpoint: its url, its subscribed events, its description, or `active` to pause and resume delivery without losing the endpoint or its secret.

Behavior

HTTP: PATCH /users/webhooks/:id

Arguments

Name	Type	Required	Description
id	string	•	Id of the webhook endpoint.
url	string	—	Where deliveries are POSTed. HTTPS only, no embedded credentials.
active	boolean	—	false pauses delivery without losing the endpoint or its secret.
events	array	—	Which events to deliver. `user.created`, `user.updated` and `user.deleted` mirror the directory; `session.revoked` fires on sign-out, ban, erase and refresh-token reuse.
description	string	—	No description in the catalog.

Response

Field	Type	Always
id	string	•
url	string	•
active	boolean	•
events	array	•
createdAt	string	•
updatedAt	string	•
description	string	•
secretPrefix	string	•

Try it

Change a webhook endpoint: its url, its subscribed events, its description, or `active` to pause and resume delivery without losing the endpoint or its secret.

When to use

Change a webhook endpoint: its url, its subscribed events, its description, or `active` to pause and resume delivery without losing the endpoint or its secret.

Example

Ask your agent something like this:

Change a webhook endpoint: its url, its subscribed events, its description, or `active` to pause and resume delivery without losing the endpoint or its secret.

The agent will invoke users_webhooks_update with these arguments:

{
  "id": "<id>"
}