Add Row to Sheet with Smartsheet API

Pipedream makes it easy to connect APIs for Smartsheet and 2,200+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Add Row to Sheet with the Smartsheet API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Add Row to Sheet with the Smartsheet API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Add Row to Sheet action
1. Connect your Smartsheet account
2. Select a Sheet
3. Optional- Configure To Top
4. Optional- Configure Cells
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Row to Sheet with Smartsheet API on New Requests from HTTP / Webhook API

HTTP / Webhook + Smartsheet

Try it

Add Row to Sheet with Smartsheet API on New Submission from Typeform API

Typeform + Smartsheet

Try it

Add Row to Sheet with Smartsheet API on New Submission (Instant) from Jotform API

Jotform + Smartsheet

Try it

Add Row to Sheet with Smartsheet API on New Custom Webhook Events from Stripe API

Stripe + Smartsheet

Try it

Add Row to Sheet with Smartsheet API on New Scheduled Tasks from Pipedream API

Pipedream + Smartsheet

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Row to Sheet on Smartsheet

Description:Adds a row to a sheet. [See docs here](https://smartsheet.redoc.ly/tag/rows#operation/rows-addToSheet)

Version:0.0.2

Key:smartsheet-add-row-to-sheet

View on GitHub

Code#

import smartsheet from "../../smartsheet.app.mjs";

export default {
  key: "smartsheet-add-row-to-sheet",
  name: "Add Row to Sheet",
  description: "Adds a row to a sheet. [See docs here](https://smartsheet.redoc.ly/tag/rows#operation/rows-addToSheet)",
  version: "0.0.2",
  type: "action",
  props: {
    smartsheet,
    sheetId: {
      propDefinition: [
        smartsheet,
        "sheetId",
      ],
      reloadProps: true,
    },
    toTop: {
      type: "boolean",
      label: "To Top",
      description: "Set to `true` to add new row to the top of the sheet",
      optional: true,
      default: false,
    },
    cells: {
      type: "string[]",
      label: "Cells",
      description: "Array of objects representing cell values. Use to manually create row when `sheetId` is entered as a custom expression. Example: `{{ [{\"columnId\": 7960873114331012,\"value\": \"New status\"}] }}`",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    const { data: columns } = await this.smartsheet.listColumns(this.sheetId, {
      params: {
        include: "columnType",
      },
    });
    if (!columns) {
      return props;
    }
    for (const column of columns) {
      props[column.id] = {
        type: "string",
        label: column.title,
        description: column?.description || "Enter the column value",
        optional: true,
      };
      if (column.type.includes("CONTACT_LIST")) {
        props[column.id] = {
          ...props[column.id],
          options: async ({ page }) => {
            const { data } = await this.smartsheet.listContacts({
              params: {
                page,
              },
            });
            return data?.map(({ email }) => email ) || [];
          },
        };
      }
      else if (column?.options) {
        props[column.id].options = column.options;
      }
    }
    return props;
  },
  async run({ $ }) {
    const {
      sheetId,
      toTop,
      cells = [],
      smartsheet,
      ...columnProps
    } = this;

    const data = {
      cells: [],
    };
    if (toTop) {
      data.toTop = true;
    }
    for (const cell of cells) {
      const cellValue = typeof cell === "object"
        ? cell
        : JSON.parse(cell);
      data.cells.push(cellValue);
    }
    for (const key of Object.keys(columnProps)) {
      data.cells.push({
        columnId: key,
        value: columnProps[key],
      });
    }

    const response = await smartsheet.addRow(sheetId, {
      data,
      $,
    });

    $.export("$summary", `Successfully created row with ID ${response.result.id}`);

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Smartsheet	`smartsheet`	`app`	This component uses the Smartsheet app.
Sheet	`sheetId`	`integer`	Select a value from the drop down menu.
To Top	`toTop`	`boolean`	Set to `true` to add new row to the top of the sheet
Cells	`cells`	`string[]`	Array of objects representing cell values. Use to manually create row when `sheetId` is entered as a custom expression. Example: `{{ [{"columnId": 7960873114331012,"value": "New status"}] }}`

Authentication#

Smartsheet uses OAuth authentication. When you connect your Smartsheet account, Pipedream will open a popup window where you can sign into Smartsheet and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Smartsheet API.

Pipedream requests the following authorization scopes when you connect your account:

ADMIN_SHEETSADMIN_SIGHTSADMIN_USERSADMIN_WEBHOOKSADMIN_WORKSPACESCREATE_SHEETSCREATE_SIGHTSDELETE_SHEETSDELETE_SIGHTSREAD_CONTACTSREAD_SHEETSREAD_SIGHTSREAD_USERSSHARE_SHEETSSHARE_SIGHTSWRITE_SHEETS