Webhooks

Rotate webhook signing secret

Generate a new signing secret.

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 4 of the 28 revisions of this API.122

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

      request-parameter-removed-with-deprecation

    • header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

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

      request-parameter-pattern-added

    • 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