Smartsheet logo

Objects

Webhook Object

callbackUrl
string

HTTPS URL where callbacks are sent.

events
Array of strings

Array of the events that are subscribed to. Currently, must be an array of size 1 that contains the string value '*.*' (asterisk period asterisk), which means "all objects" and "all events".

name
string

Webhook name.

version
number [ 1 .. 1 ]

Webhook version. Currently, the only supported value is 1. This attribute is intended to ensure backward compatibility as new webhook functionality is released. For example, a webhook with a version of 1 is guaranteed to always be sent callback objects that are compatible with the version 1 release of webhooks.

enabled
boolean

Indicates whether the webhook is on (true) or off (false).

id
number

Webhook Id.

apiClientId
string

API client Id corresponding to third-party app that created the webhook. Read-only. Only present if webhook was created by third-party app.

scopeObjectId
number

Id of the object that is subscribed to. Specified when a webhook is created and cannot be changed.

apiClientName
string

API client name corresponding to third-party app that created the webhook. Read-only. Only present if webhook was created by third-party app.

string or number
disabledDetails
string

Details about the reason the webhook was disabled. Read-only. Only present when enabled=false.

string or number
scope
string

Scope of the subscription. Currently, the only supported value is sheet. Specified when a webhook is created and cannot be changed.

sharedSecret
string

Shared secret for this Webhook, randomly generated by Smartsheet. Read-only. See Authenticating Callbacks for details about how this value can be used.

object
status
string

Webhook status. Read-only. See Webhook Status for list of possible values.

Enum: "DISABLED_ADMINISTRATIVE" "DISABLED_APP_REVOKED" "DISABLED_BY_OWNER" "DISABLED_CALLBACK_FAILED" "DISABLED_SCOPE_INACCESSIBLE" "DISABLED_VERIFICATION_FAILED" "ENABLED" "NEW_NOT_VERIFIED"
object

An object that contains an array of column Ids if you want to limit the subscription to a subscope. Specified when a webhook is created and cannot be changed.

{
  • "callbackUrl": "https://www.myApp.com/webhooks",
  • "events": [
    ],
  • "name": "Webhook for Sheet Creation",
  • "version": 1,
  • "enabled": true,
  • "id": 8444254503626628,
  • "apiClientId": 555555,
  • "scopeObjectId": 3285357287499652,
  • "apiClientName": "Awesome Smartsheet Application",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "disabledDetails": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "scope": "sheet",
  • "sharedSecret": "216ejjzdnq17mq1q8xs7d4hu8b",
  • "stats": {
    },
  • "status": "ENABLED",
  • "subscope": {
    }
}

Callback Object

scopeObjectId
number

Id of the object that corresponds to scope.

webhookId
number

Id of the corresponding webhook.

Array of objects

Array of CallbackEvent objects

newWebhookStatus
string

New status of the corresponding webhook. Only returned for webhook status change callbacks (null for event callbacks).

nonce
string

Random value that is distinct for each callback.

scope
string

Scope of the webhook. Currently, the only supported value is sheet.

Value: "sheet"
timestamp
string <date-time>

Time that the callback was generated.

{
  • "scopeObjectId": 3285357287499652,
  • "webhookId": 8444254503626628,
  • "events": [
    ],
  • "newWebhookStatus": "ENABLED",
  • "nonce": "string",
  • "scope": "sheet",
  • "timestamp": "2019-08-24T14:15:22Z"
}

CallbackEvent Object

id
number

Id of the object that corresponds to objectType. Omitted if objectType is cell.

columnId
number Nullable

Only present if objectType is cell. The Id of the column where the cell is located.

rowid
number Nullable

Only present if objectType is cell. The Id of the row where the cell is located.

userid
number

The user Id of the person who caused this event.

objectType
string

Type of object for which event occurred.

Enum: "attachment" "cell" "column" "comment" "discussion" "row" "sheet"
changeAgent
string

A comma-delimited list of values that uniquely identify the agents responsible for making the changes that caused the callback to occur. Only present if the change agent included the Smartsheet-Change-Agent header in the API request that changed data in Smartsheet. For more information, see Preventing Infinite Loops.

eventType
string

Type of Event that occurred.

Enum: "created" "deleted" "updated"
timestamp
string <date-time>

Time that this event occurred. A callback may contain events with different timestamps, as multiple separate events may be aggregated into a single callback request.

{
  • "id": 3285357287499652,
  • "columnId": 0,
  • "rowid": 0,
  • "userid": 48569348493401210,
  • "objectType": "sheet",
  • "changeAgent": "string",
  • "eventType": "created",
  • "timestamp": "2019-08-24T14:15:22Z"
}

SharedSecret Object

sharedSecret
string

Value for the shared secret.

{
  • "sharedSecret": "string"
}

Subscope Object

columnIds
Array of numbers

A column Id or Ids

{
  • "columnIds": [
    ]
}
➔ Next to Methods