In this article
You can use this Snap to subscribe to the specified spreadsheet for notifications of the changes in the Google Sheet.
Google Sheets Subscribe Snap is a READ-type Snap.
None.
Works in Ultra Pipelines.
This Snap does not support Shared Drive or other Drives—it supports only My Drive.
If you subscribe to a Spreadsheet with multiple channels simultaneously, you will receive multiple notifications.
If you configure Webhook URL using a Triggered task, there is a two to four-minute delay in receiving notifications on the Channel or Spreadsheet.
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| The Spreadsheet name or ID, Channel ID, and Webhook URL. |
Output | Document |
|
| The Snap returns ID, resource ID, and resource URI. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
|
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value: Google Sheet Subscribe | String | Specify a unique name for the Snap. | |
Include Shared Drives Default Value: Deselected | Checkbox | Select this checkbox to include files from the shared drive. Deselect this checkbox to exclude files from the shared drive. This Snap does not support Shared Drive or other Drives—it supports only My Drive. This Snap does not support Shared Drive or other Drives—it supports only My Drive. | |
Display Spreadsheet ID in Suggestions Default Value: Deselected | Checkbox | Select this checkbox to display Spreadsheets ID with the Spreadsheet name in the Spreadsheets Suggestions list. | |
Spreadsheet Default value: N/A | String/Expression/Suggestion | Specify or select the spreadsheet name or ID (or both) containing the worksheet to be subscribed to. | |
Webhook URL Default value: N/A | String/Expression | Specify the Webhook URL to allow Google to send notifications. Webhook URL is similar to Target URL. To get a target URL, you must create a triggered task. Learn more about Creating a Triggered Task and Running a Triggered Task. Webhook URL is similar to Target URL. To get a target URL, you must create a triggered task. Learn more about Creating a Triggered Task and Running a Triggered Task. Watch the video for more information about how to obtain Webhook URL. | |
Channel ID Default value: Math.randomUUID() | String/Expression | Specify a UUID or similar unique string that identifies the channel. | |
Expiration (in Minutes) Default value: 60 | Integer/Expression | Specify the time in minutes after which the subscription expires.
| |
Snap Execution Default Value: Validate & Execute | Dropdown list | Select one of the following three modes in which the Snap executes:
|
This example Pipeline demonstrates how to subscribe to and unsubscribe from a spreadsheet using Google Sheet Subscribe and Unsubscribe Snaps.
First, configure the Google Sheet Subscribe Snap to subscribe to the new spreadsheet for update notifications. Specify the following details:
Spreadsheet: The spreadsheet name to subscribe.
Webhook URL: The target URL to which the notifications should be delivered.
Channel ID: The ID of the channel to which the spreadsheet belongs.
Expiration: The expiration time for the subscription with the resource ID.
The following image shows how to do this configuration and the resulting output:
Next, configure the Mapper Snap to extract the $id
and $resourceId
:
Finally, configure the Google Sheet Unsubscribe Snap to unsubscribe the spreadsheet as shown.
The following video demonstrates how to obtain Webhook URL.
Obtain Webhook URL Using Google Sheet Subscribe.mp4
|
Related Content