webhooks

Reset shared secret

Resets the shared secret for the specified webhook.

You can improve security by using this operation to rotate an API client webhooks' shared secrets at periodic intervals.

For more information about how a shared secret is used, see the Authenticating callbacks section in Webhook callbacks.

post/webhooks/{webhookId}/resetSharedSecret

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: ADMIN_WEBHOOKS

Headers

Content-Typestring

Required for POST and PUT requests. Defines the structure for the request body.

Response

OK

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation
versionnumber nullable

New version of the sheet. Applicable only for operations which update sheet data.

Example response

{
  "message": "SUCCESS"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.