v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

webhooks

List webhooks

Gets the list of all webhooks that the user owns (if a user-generated token was used to make the request) or the list of all webhooks associated with the third-party app (if a third-party app made the request). Items in the response are ordered by API creation date (most recent first).

Note: In the response, each webhook's events field defaults to ["*.*"], regardless of its actual value. Alternatively, call GET /webhook/{webhookId} on an individual webhook to get its events value.

get/webhooks

Query parameters

pagenumber

Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.

pageSizenumber

The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.

Response

The List of Webhooks

pageNumbernumber

The current page.

Note: when a page number greater than total number of pages is requested, the last page is instead returned.

pageSizenumber nullable

The number of items in the current page.

totalPagesinteger

totalCountinteger

Example response

{
  "pageNumber": 1,
  "pageSize": 50,
  "totalPages": -1,
  "totalCount": -1,
  "data": [
    {
      "callbackUrl": "https://www.myApp.com/webhooks",
      "name": "My webhook",
      "id": 8444254503626628,
      "apiClientId": "555555",
      "apiClientName": "Awesome Smartsheet Application",
      "sharedSecret": "216ejjzdnq17mq1q8xs7d4hu8b",
      "events": [
        "*.*"
      ],
      "scope": "plan",
      "scopeObjectId": 3285357287499652,
      "status": "NEW_NOT_VERIFIED",
      "version": 1,
      "customHeaders": {
        "YOUR_CUSTOM_HEADER_KEY_1": "YOUR_CUSTOM_HEADER_VALUE_1",
        "YOUR_CUSTOM_HEADER_KEY_2": "YOUR_CUSTOM_HEADER_VALUE_2"
      }
    }
  ]
}