With the June 2016 release, we’re pleased to announce a number of enhancements to existing endpoints and objects - to support new product features and functionality.

 

Release Highlights

Highlights of this release include:

  • Webhooks general availability - we successfully completed our public beta and pleased to announce that Webhooks are now officially released and available to all Smartsheet customers.  The complete Webhooks documentation is included in our API docs.

  • Updates for existing endpoints and objects to support new product features:

    • full CRUD support for Update Requests, including the ability to manage scheduled (future) update requests and retrieve information about already sent update requests

    • adding and updating predecessors in Gantt enabled sheets

    • indenting and outdenting rows

    • new createdAt and modifiedAt parameters for the Share object

    • retrieving sheets, reports and sights based on modifiedSince attribute

 

Webhooks

Webhooks public beta has been successfully completed and we are pleased to announce that Webhooks are now officially released and available to all Smartsheet customers in production.

 

First, make sure to read up on how our Webhooks work - see our detailed Webhooks documentation.  Pay particular attention to the verification requirements and flow - we take it a step further than most webhook implementations.  We recognize that this may require additional development effort (hopefully, small), but we have made a decision to follow security best practices to ensure we are good netizens and protect our customers.  The other important thing to keep in mind is that our webhook notification payloads are what's called "skinny" - they will let you know which objects have changed, but will not include the actual data changes.  If you are interested in the data that has changed, you will need to make a followup call to the Smartsheet API to retrieve it.

 

Along with the GA announcement, we are also releasing the following improvements to Webhooks:

  • require verification when re-enabling an owner-disabled webhook

  • new "stats" info added to Webhook object - including retry count, and timestamp for last successful callback

  • new attributes added to the callback payload - including "userId" to indicate user responsible for the change in the app, and "timestamp" of the change

  • fixed - eliminated performance degradation over time

  • fixed - JSON parse exception


 

New Endpoints

The following new endpoints have been added to API 2.0:

 

Operation

HTTP Method

Endpoint

List Update Requests

GET

/sheets/{sheetId}/updaterequests

Get Update Request

GET

/sheets/{sheetId}/updaterequests/{updateRequestId}

Modify Update Request

PUT

/sheets/{sheetId}/updaterequests/{updateRequestId}

Delete Update Request

DELETE

/sheets/{sheetId}/updaterequests/{updateRequestId}

List Sent Update Requests

GET

/sheets/{sheetId}/sentupdaterequests

Get Sent Update Request

GET

/sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}

Delete Sent Update Request

DELETE

/sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}


 

Updated operations

The following existing operations have been updated:  

 

Operation

Change(s)

List Sheets

Now supports new query string parameter "modifiedSince"

List All Org Sheets

Now supports new query string parameter "modifiedSince"

Get Sheet

Now supports new "include" query string option "objectValue" to return an object representation of cell value (to assist with updating predecessors)

Get Row

Now supports new "include" query string option "objectValue" to return an object representation of cell value (to assist with updating predecessors)

Add Row(s)

Now supports new cell attribute "objectValue" required when making changes to predecessor cells

Update Row(s)

Now supports new cell attribute "objectValue" required when making changes to predecessor cells

List Reports

Now supports new query string parameter "modifiedSince"

List Sights

Now supports new query string parameter "modifiedSince"

Create Update Request

Modified from using "MultiRowEmail" object to using the "UpdateRequest" object - this change is backward compatible

Update Webhook

Now requires webhook verification when re-enabling an owner-disabled webhook


 

New Objects

To facilitate the new endpoints and API enhancements described above, the following new objects have been added:

 

 

Updated Objects

To facilitate the new endpoints and API enhancements described above, the following objects have been updated:

 

Object

Change(s)

MultiRowEmail

New attribute: layout

Cell

New attribute: objectValue (optional)

UpdateRequest

New attributes: sentBy, schedule, createdAt, modifiedAt

Row

New attribute: indent

Webhook

New attribute: "stats" object that includes retry count and timestamp for last successful callback

CallbackEvent

New attributes: userId (to indicate user responsible for the change event being reported), timestamp (to indicate the date/time of the change event being reported)


 

What now?

If you’re already using API 2.0 or are building a new integration,  you can start taking advantage of these API enhancements right away.  Changes to existing endpoints are non-breaking and backwards-compatible with API 2.0.  See the Smartsheet API 2.0 documentation for comprehensive information about our API, and check out the Smartsheet Developer Portal for additional resources to help you along the way.

 

If you’re still using API 1.1, we strongly recommend upgrading your integration to API 2.0 so that you can take advantage of the new features and functionality.  It’s now been over 6 months since we announced the deprecation of API 1.1 -- you should upgrade to API 2.0 now to avoid any disruption when API 1.1 is discontinued on July 31, 2016.  See the API 2.0 Release Notes for helpful information about migrating from API 1.1 to API 2.0.

 

As always, we’re here to support you - if you have feedback about API 2.0, questions about migrating from API 1.1 to API 2.0, ideas about new features, or run into an issue using the API, ping us at api@smartsheet.com.


 

- The Smartsheet Platform Team


 

Categories

Comments

Hello Michele, Thanks for your question. While we don't have specific Card View related events for Webhooks, they can be used to be notified of changes or events happening in a sheet. Cards represent rows in the sheet, therefore as new cards are created or existing ones are updated it would trigger row related events for Webhooks. With this, Webhooks could be used to be alerted of changes happening in the sheet. More information on using Webhooks can be found here: http://smartsheet-platform.github.io/api-docs/#webhooks. For any additional questions with this matter, please contact the API team at api@smartsheet.com - Best regards, The Smartsheet Team

Add new comment