Skip to main content

Smart Sheet Component

Interact with the Smart Sheet API

Component key: smartsheet

Description#

Smartsheet is a software as a service offering for collaboration and work management, developed and marketed by Smartsheet Inc. This component allows you to manage and interact with a Smartsheet file.

Authorization Notes#

Information about getting started and creating API keys with Smartsheet can be found on their developer documentation site.

Triggers#

Webhook#

Trigger for handling webhooks from Smartsheet | key: webhook

You can configure a Smartsheet webhook to send information to a Prismatic webhook URL under certain conditions (a "Column" is updated, a "Row" is deleted, etc.).

For more information on configuring webhooks refer to the Microsoft Graph API Docs

Additionally, you can reference a trigger's results.webhookUrls to create a webhook in a deploy-triggered flow. That'll configure webhooks to point to an instance when that instance is deployed to a customer.

Output Example Payload#

{  "payload": {    "headers": {      "accept": "*/*",      "Content-Type": "application/json",      "User-Agent": "Apache-HttpClient/4.5.1 (Java/11.0.12)",      "Host": "hooks.example.prismatic.io"    },    "body": {      "data": {        "webhookId": "example098093842",        "challenge": "example32482-237762-234"      }    },    "rawBody": {      "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] }    },    "queryParameters": {},    "webhookUrls": {      "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA=="    },    "webhookApiKeys": { "Flow 1": ["abc-123"] },    "customer": {      "externalId": "customer-example-external-id",      "name": "John Doe"    }  }}

Actions#

Add/Update Row#

Adds or Updates a Row on the specified Sheet | key: upsertRow

InputKeyNotesExample

Column Values

string
columnValuesA list of columns to be updated with the specified valueTask Name: My Todo

Log Level

string
logLevelProvide a string value for log level

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Row Identifier

string
updateIdentifierAn identifier used to find a Row for Update

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Copy Rows#

Copies multiple rows from the sheet specified in the action to (the bottom of) another sheet. | key: copyRows

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Row ID

string
/ Required
rowIdsFor each list item, provide a value for the Row ID of the row you would like to copy.6830028284938

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Copy To Sheet ID

string
/ Required
toSheetIdProvide a string value for the Sheet ID of the sheet you would like to insert the copied values into6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Create Webhook#

Create a new webhook | key: createWebhook

InputKeyDefaultNotesExample

CallbackURL

string
/ Required
callbackUrlProvide a valid URL that represents your callback URL. To set up a smartsheet trigger, enter your trigger URL here.https://hooks.prismatic.io/EXAMPLE

Object Id Of Scope

string
/ Required
scopeObjectIdProvide the unique identifier of the scope object you provided.sheet_3285357287499652

Subscope

code
subscope
{ columnIds: [7318427511613316, 7318427511613123] }
Provide a JavaScript Object with a list property 'columnIds' This enables your webhook to capture activity in a specific column of your sheet.*.*

Events

string
/ Required
webhookEventsFor each item, provide an event you would like to watch.*.*

Webhook Name

string
/ Required
webhookNameProvide a string value for the name of the webhook.MyExampleWebhook

Scope

string
/ Required
webhookScopeProvide a string value for the scope of the webhook.sheet

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Delete Column#

Delete a column on the specified Sheet | key: deleteColumn

InputKeyNotesExample

Column Title

string
/ Required
columnTitleProvide a value for the title of the column.Due Date

Log Level

string
logLevelProvide a string value for log level

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Delete Row#

Deletes a row on the specified Sheet | key: deleteRow

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Row Identifier

string
/ Required
rowIdentifierAn identifier used to find a Row

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Get Column#

Lists the Columns in the specified Sheet | key: getColumn

InputKeyNotesExample

Column Title

string
/ Required
columnTitleProvide a value for the title of the column.Due Date

Log Level

string
logLevelProvide a string value for log level

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Get Row#

Get all the cells and their values in a given row | key: getRow

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Row Identifier

string
/ Required
rowIdentifierAn identifier used to find a Row

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Get Sheet#

Get the information and metadata of a sheet by ID | key: getSheet

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


List Columns#

Lists the Columns in the specified Sheet | key: listColumns

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


List Sheets#

Lists sheets in a project. | key: listSheets

InputKeyNotes

Log Level

string
logLevelProvide a string value for log level

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Search All#

Searches for the specified text in all Sheets the user can access. | key: searchAll

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Search Text

string
/ Required
queryTextA string of text used to search a sheet.Any Text

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Search Sheet#

Searches for the specified text in a Sheet. | key: searchSheet

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Search Text

string
/ Required
queryTextA string of text used to search a sheet.Any Text

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key


Synchronous Search#

Searches a Sheet for specified text (may perform worse that SearchSheet depending on dataset) | key: syncSearch

InputKeyNotesExample

Log Level

string
logLevelProvide a string value for log level

Search Text

string
/ Required
queryTextA string of text used to search a sheet.Any Text

Sheet ID

string
/ Required
sheetIdProvide a string value for the Sheet ID6830028284938

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key