SMsmartsheet
webhooks

Update webhook

Changed on

Updates the matching Webhook.

Important: If you set enabled to true, the behavior and result depend on the webhook's status and may trigger a webhook verification or, in some cases, cause an error. See Webhook status for details.

Note: You can pass custom headers in your webhook requests, which Smartsheet then adds to all requests that the webhook sends to your callback URL. This is useful for including authentication tokens or other information your application needs. To do this, add a customHeaders object to the request body, with each key-value pair representing a header and its value.

See also:

  • customHeaders body parameter in the Body section below
  • Launch a plan-level webhook
  • Create a plan event-handling endpoint article

Note: For sheet webhooks, you can update the events array to filter which events trigger callbacks. Specify event patterns like ["row.created", "cell.updated"], or use ["*.*"] to receive all event types. See the events property for supported patterns.

put/webhooks/{webhookId}

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.

Request body

OR

Example request

{
  "callbackUrl": "https://www.myApp.com/webhooks",
  "name": "My webhook",
  "id": 8444254503626628,
  "apiClientId": "555555",
  "apiClientName": "Awesome Smartsheet Application",
  "sharedSecret": "216ejjzdnq17mq1q8xs7d4hu8b",
  "events": [
    "*.*"
  ],
  "scope": "sheet",
  "scopeObjectId": 3285357287499652,
  "status": "NEW_NOT_VERIFIED",
  "version": 1,
  "customHeaders": {
    "YOUR_CUSTOM_HEADER_KEY_1": "YOUR_CUSTOM_HEADER_VALUE_1",
    "YOUR_CUSTOM_HEADER_KEY_2": "YOUR_CUSTOM_HEADER_VALUE_2"
  },
  "enabled": true
}

Response

Result object containing the Webhook object for the updated webhook

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

Example response

{
  "message": "SUCCESS",
  "result": {
    "callbackUrl": "https://www.myApp.com/webhooks",
    "name": "My webhook",
    "id": 8444254503626628,
    "apiClientId": "555555",
    "apiClientName": "Awesome Smartsheet Application",
    "sharedSecret": "216ejjzdnq17mq1q8xs7d4hu8b",
    "events": [
      "*.*"
    ],
    "scope": "plan",
    "scopeObjectId": 3285357287499652,
    "status": "NEW_NOT_VERIFIED",
    "version": 1,
    "customHeaders": {
      "YOUR_CUSTOM_HEADER_KEY_1": "YOUR_CUSTOM_HEADER_VALUE_1",
      "YOUR_CUSTOM_HEADER_KEY_2": "YOUR_CUSTOM_HEADER_VALUE_2"
    }
  }
}

Changes

  • d74a1cc23d50Revision changes
    • info

      removed the enum value DISABLED_EXCEEDED_GRID_LIMITS of the request read-only property allOf[subschema #1]/oneOf[subschema #2: Sheet webhook]/allOf[subschema #2]/status

    • info

      removed the DISABLED_EXCEEDED_GRID_LIMITS enum value from the ///// response property for the response status