rotate_webhook_secret

Remaining arguments go in a JSON object body. Empty or unreadable body is treated as {} by this resource handler; use {retire:true} to retire the older secret.

post/v1/webhooks/{endpointId}/secrets

Request

  • Base URL: https://app.agentlinkops.com
  • URL: https://app.agentlinkops.com/v1/webhooks/{endpointId}/secrets
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

endpointIdstring required

endpoint ID from create/list.

Headers

X-Workspace-IDstring

Required when using a Clerk human session. With an API key, omit this header or supply its bound workspace.

Request body

retireboolean

First call with false to issue a new secret, save it and update the receiver. Then call with true to retire the older secret; true alone never rotates.

Response

Remaining arguments go in a JSON object body. Empty or unreadable body is treated as {} by this resource handler; use {retire:true} to retire the older secret.

idstring required

Resource identifier returned by the operation.

active_secretsnumber required
retiredboolean required
secretstring

Webhook signing secret returned only when created or rotated. Store it securely.

Changes

No recorded changes to this operation across all 1 revision of this API.