Webhook status
A Webhook object's enabled attribute indicates whether a webhook is enabled or disabled, while the status attribute describes the reason that the webhook is enabled or disabled.
Note:
- When a Webhook object's
enabledattribute is set totrue, Smartsheet is monitoring for the specified events and sends a callback (see the Event Callbacks section) to thecallbackUrlwhen the events occur.- When a Webhook object's
enabledattribute is set tofalse, Smartsheet is not monitoring for the specified events and does not send a callback to thecallbackUrlwhen the events occur. Depending on the value of thestatusattribute, it may be possible to (re-)enable the webhook. (See below for details).
The following table lists all possible combinations of enabled and status attribute values.
| Webhook.enabled | Webhook.status | Meaning | Notes |
|---|---|---|---|
true | ENABLED | Webhook is active. | |
false | NEW_NOT_VERIFIED | Webhook has been created but is not enabled because it has not yet been verified. | Owner can re-enable the webhook by using the Update webhook operation to set enabled to true. Once the subscriber successfully acknowledges the verification request (see the Webhook Verification section), the webhook is enabled. |
false | DISABLED_ADMINISTRATIVE | Webhook has been disabled by Smartsheet support. | A webhook in this state can only be re-enabled by Smartsheet (contact Support). Attempting to re-enable a webhook in this state results in error code 1154. |
false | DISABLED_APP_REVOKED | Webhook has been disabled because the third-party app associated with the webhook has had its access revoked. | This is a terminal state (that is, webhook in this state cannot be re-enabled, and attempts to do so result in error code 1153). If the third-party app's access is subsequently restored, it must create new webhooks. |
false | DISABLED_BY_OWNER | Webhook has been disabled by the owner. | Owner can re-enable the webhook by using the Update webhook operation to set enabled to true. Once the subscriber successfully acknowledges the verification request (See the Webhook Verification section), the webhook is enabled. |
false | DISABLED_CALLBACK_FAILED | Webhook has been disabled because callback was not successfully delivered to the callback URL. | Owner can re-enable the webhook by using the Update webhook operation to set enabled to true. Once the subscriber successfully acknowledges the verification request (see the Webhook Verification section), the webhook is enabled. |
false | DISABLED_EXCEEDED_GRID_LIMITS | Sheet webhook has been disabled because the sheet has 20,000 rows, 400 columns, or 500,000 cells. | Owner can enable the webhook by first reducing the sheet size to within the specified limits and then executing the Update webhook operation with the enabled body attribute set to true. |
false | DISABLED_SCOPE_INACCESSIBLE | Webhook has been disabled because its owner lost access to the corresponding data in Smartsheet (either because the object was deleted or sharing permissions were revoked). | Webhook is automatically re-enabled if access to data is restored (for example, if deleted object is restored or sharing permissions are restored). |
false | DISABLED_VERIFICATION_FAILED | Webhook verification has failed. | Owner can re-enable the webhook by using the Update webhook operation to set enabled to true. Once the subscriber successfully acknowledges the verification request (see the **Webhook Verification section), the webhook is enabled. |