Skip to content

users_webhooks_rotate_secret

Mint a NEW signing secret for this endpoint and return it exactly once.

Tool

users_webhooks_rotate_secret

Mint a NEW signing secret for this endpoint and return it exactly once.

Mint a NEW signing secret for this endpoint and return it exactly once. The previous secret keeps verifying for 24 hours — both signatures ride the webhook-signature header — so a receiver can swap its copy without dropping a delivery.

Behavior

HTTP
POST /users/webhooks/:id/rotate-secret

Arguments

Name
Type
Required
Description
id
string
•
Id of the webhook endpoint.

Response

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

Try it

Mint a NEW signing secret for this endpoint and return it exactly once.

When to use

Mint a NEW signing secret for this endpoint and return it exactly once. The previous secret keeps verifying for 24 hours — both signatures ride the webhook-signature header — so a receiver can swap its copy without dropping a delivery.

Example

Ask your agent something like this:

Mint a NEW signing secret for this endpoint and return it exactly once.

The agent will invoke users_webhooks_rotate_secret with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select