Webhook for Sheet Creation?

wren
wren
edited 02/20/25 in API & Developers

The docs show an example webhook creation request:

```
{
"callbackUrl": "https://www.myApp.com/webhooks",
"events": [
"."
],
"name": "Webhook for Sheet Creation",
"version": 1
}
```

This gets you the following error:
```
{'errorCode': 1012, 'message': 'Required object attribute(s) are missing from your request: webhook.scope.', 'refId': '35r5fu'}
```

So, my question is — is there a way to create a webhook that will be triggered when either a new sheet is created or an existing sheet is copied/cloned?

Answers

  • jmyzk_cloudsmart_jp
    jmyzk_cloudsmart_jp Community Champion

    Hi @wren

    Unfortunately, no. Smartsheet webhooks cannot directly detect sheet creation or cloning since webhooks require a scope (either "sheet" or sub-scope "columns") and only track changes within a sheet.

    Workarounds:

    • Polling + Comparison
      • Periodically fetch all sheets (GET /sheets).
      • Compare sheet IDs with a stored list to detect new sheets.
    • Event Reporting API (Enterprise Plan)
      • Use the Audit Log API to track sheet creation events more reliably.

    https://smartsheet.redoc.ly/tag/eventsDescription/

    NOTE: Event Reporting is a premium add-on which can be purchased for Enterprise and Advance Platinum plans only. For details on the Event Reporting add-on, please contact our Sales Team.

    {
    "nextStreamPosition": "XyzAb1234cdefghijklmnofpq",
    "moreAvailable": true,
    "data": [
    {
    "eventId": "4b12345abc444def333g149he2b15b3j",
    "objectType": "sheet",
    "action": "CREATE",
    "objectId": 345678901234,
    "eventTimeStamp": "2019-08-24T14:15:22Z",
    "userId": 123457654321,
    "requestUserId": 133445566778,
    "accessTokenName": "string",
    "source": "WEB_APP",
    "additionalDetails": {}
    }
    ]
    }