Sign in
Webhooks

Rotate webhook signing secret

Rotate the webhook signing secret. The new secret is returned only once.

post/webhooks/{webhookId}/rotate-secret

Path parameters

webhookIdstring required

Webhook ID (whk_*).

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Request body

Response

Successful Response

Changes

Changed in 5 of the 50 revisions of this API.1214

  • c7c12da5915f12See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • 0bb9c54b1f611See the full diff
    • ▲

      added the pattern ^whk_[0-9a-f]{32}$ to the path request parameter webhookId

      request-parameter-pattern-added

  • 270e233e401c2See the full diff
    • ●

      for the header request parameter Idempotency-Key, the maxLength was set to 255

      request-parameter-max-length-set

    • ●

      for the path request parameter webhookId, the maxLength was set to 64

      request-parameter-max-length-set