Webhook event types
Each smartsheet webhook sends notifications (callbacks) about events affecting its scope object (for example, a sheet or plan).
This article explains event filtering (for plan webhooks) and describes events you can configure webhooks to send.
Event filtering
You can configure plan webooks to send callbacks that include specific events affecting a plan.
For example, you can set the following attributes on a plan webhook to have it send only user seat type update event notifications.
"scope": "plan"
"events": "user.seatType.updated"Alternatively, you can use plan webhook event patterns to filter on hierarchical groupings that automatically expand to include future event types.
The table below shows a range of patterns, starting with the most general pattern, to filter on plan events.
| Pattern | Coverage | Use Case |
|---|---|---|
"*.*" | All plan events (current and future) | Comprehensive monitoring, maximum future-proofing |
"user.*" | All user-related events (current and future) | Monitor all user management activities |
"user.seatType.*" | All seat type-related events (current and future) | Focus on seat type changes |
"user.seatType.updated" | Single event type | Targeted monitoring for specific workflows |
Important: Currently, only plan webhooks support event filtering.
All other webhooks, such as sheet webhooks, support only using the all events (
"*.*") event pattern.
Sheet events
Sheet webhooks (where "scope": "sheet") send callbacks that contain sheet-related events.
Sheet webhooks only support sending callbacks that include all of the sheets events -- you must set "events": "*.*".
Note: For details, see the sheet webhook schema.
Plan events
Plan webhooks (where "scope": "plan") send callbacks that contain plan-related events.
The following sections describe events that you can configure a plan webhook to send.
Note: For details, see the plan webhook schema.
User seat type events
You can use any combination of the following events attribute patterns to configure a plan webhook to send specific user seat type events.
| Pattern | Description |
|---|---|
"*.*" | All plan events (current and future) |
"user.*" | All user-related events (current and future) |
"user.seatType.*" | All user seat type-related events (current and future) |
"user.seatType.updated" | All user seat type updates |