Users

users_webhooks_create

Tool

users_webhooks_create

Register an outbound webhook endpoint for this product. Deliveries are signed with the Standard Webhooks wire format (webhook-id / webhook-timestamp / webhook-signature). The signing secret is returned EXACTLY ONCE — it is derived, never stored, so a lost secret is rotated with users_webhooks_rotate_secret, never recovered.

Behavior

HTTP: POST /users/webhooks

Arguments

Name	Type	Required	Description
url	string	•	Where deliveries are POSTed. HTTPS only, no embedded credentials.
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	—	A label only humans read — which system this endpoint feeds.

Response

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

Try it

Register an outbound webhook endpoint for this product.

When to use

Example

Ask your agent something like this:

Register an outbound webhook endpoint for this product.

The agent will invoke users_webhooks_create with these arguments:

{
  "url": "<url>",
  "events": "<events>"
}