OpenAPI Specification
openapi: 3.1.0
info:
title: Smartsheet Columns Webhooks API
description: Smartsheet is a SaaS work management and collaboration platform. The Smartsheet REST API v2.0 provides programmatic access to sheets, rows, columns, reports, workspaces, users, attachments, and webhooks. Authentication uses OAuth 2.0 or Bearer API access tokens.
version: 2.0.0
contact:
name: Smartsheet API
url: https://developers.smartsheet.com/api/smartsheet/openapi
servers:
- url: https://api.smartsheet.com/2.0
description: Smartsheet REST API (US)
- url: https://api.smartsheet.eu/2.0
description: Smartsheet REST API (EU)
- url: https://api.smartsheet.au/2.0
description: Smartsheet REST API (AU)
security:
- ApiToken: []
- OAuth2: []
tags:
- name: Webhooks
description: Manage webhook subscriptions.
paths:
/webhooks:
get:
summary: List webhooks
description: List the webhooks the user owns.
operationId: listWebhooks
tags:
- Webhooks
responses:
'200':
description: A list of webhooks.
content:
application/json:
schema:
type: object
post:
summary: Create webhook
description: Create a new webhook subscription.
operationId: createWebhook
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Webhook created.
content:
application/json:
schema:
type: object
components:
securitySchemes:
ApiToken:
type: http
scheme: bearer
description: Smartsheet API access token sent in the Authorization header as a Bearer token.
OAuth2:
type: oauth2
description: Smartsheet OAuth 2.0 authorization.
flows:
authorizationCode:
authorizationUrl: https://app.smartsheet.com/b/authorize
tokenUrl: https://api.smartsheet.com/2.0/token
scopes:
READ_SHEETS: View sheets
WRITE_SHEETS: Edit sheets
SHARE_SHEETS: Share sheets
DELETE_SHEETS: Delete sheets
ADMIN_SHEETS: Sheet admin
ADMIN_WORKSPACES: Workspace admin
ADMIN_USERS: User admin
ADMIN_WEBHOOKS: Webhook admin
READ_USERS: View users
READ_CONTACTS: View contacts