C# Class Smartsheet.Api.Internal.WebhookResourcesImpl

Inheritance: AbstractResources, WebhookResources
Show file Open project: smartsheet-platform/smartsheet-csharp-sdk

Public Methods

Method Description
CreateWebhook ( Webhook webhook ) : Webhook

Creates a new Webhook.

The request body is limited to name(required), callbackUrl (required), scope (required) scopeObjectId (required), events(required), version(required)

It mirrors To the following Smartsheet REST API method:POST /webhooks
DeleteWebhook ( long webhookId ) : void

Delete a webhook.

It mirrors To the following Smartsheet REST API method: DELETE /webhooks/{webhookId}
GetWebhook ( long webhookId ) : Webhook

Gets the Webhook specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /webhook/{webhookId}
ListWebhooks ( PaginationParameters paging ) : PaginatedResult

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 Client name, then Webhook name, then creation date.

It mirrors To the following Smartsheet REST API method: GET /webhooks
ResetSharedSecret ( long webhookId ) : WebhookSharedSecret

Resets the shared secret for the specified Webhook. For more information about how a shared secret is used, see Authenticating Callbacks.

The request body should be empty

It mirrors To the following Smartsheet REST API method: POST /webhooks/{webhookId}/resetsharedsecret
UpdateWebhook ( Webhook webhook ) : Webhook

Updates the Webhook specified in the URL.

The request body is limited to the name, events, callbackUrl, enabled and version attributes.

It mirrors To the following Smartsheet REST API method: PUT /webhooks/{webhookId}
WebhookResourcesImpl ( SmartsheetImpl smartsheet ) : System

Constructor. Exceptions: - IllegalArgumentException : if any argument is null

Method Details

CreateWebhook() public method

Creates a new Webhook.

The request body is limited to name(required), callbackUrl (required), scope (required) scopeObjectId (required), events(required), version(required)

It mirrors To the following Smartsheet REST API method:POST /webhooks

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public CreateWebhook ( Webhook webhook ) : Webhook
webhook Smartsheet.Api.Models.Webhook the webhook to be created
return Smartsheet.Api.Models.Webhook

DeleteWebhook() public method

Delete a webhook.

It mirrors To the following Smartsheet REST API method: DELETE /webhooks/{webhookId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public DeleteWebhook ( long webhookId ) : void
webhookId long the sightId
return void

GetWebhook() public method

Gets the Webhook specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /webhook/{webhookId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public GetWebhook ( long webhookId ) : Webhook
webhookId long the Id of the webhook
return Smartsheet.Api.Models.Webhook

ListWebhooks() public method

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 Client name, then Webhook name, then creation date.

It mirrors To the following Smartsheet REST API method: GET /webhooks

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public ListWebhooks ( PaginationParameters paging ) : PaginatedResult
paging Smartsheet.Api.Models.PaginationParameters
return PaginatedResult

ResetSharedSecret() public method

Resets the shared secret for the specified Webhook. For more information about how a shared secret is used, see Authenticating Callbacks.

The request body should be empty

It mirrors To the following Smartsheet REST API method: POST /webhooks/{webhookId}/resetsharedsecret

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public ResetSharedSecret ( long webhookId ) : WebhookSharedSecret
webhookId long the sightId
return Smartsheet.Api.Models.WebhookSharedSecret

UpdateWebhook() public method

Updates the Webhook specified in the URL.

The request body is limited to the name, events, callbackUrl, enabled and version attributes.

It mirrors To the following Smartsheet REST API method: PUT /webhooks/{webhookId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public UpdateWebhook ( Webhook webhook ) : Webhook
webhook Smartsheet.Api.Models.Webhook the webhook To update
return Smartsheet.Api.Models.Webhook

WebhookResourcesImpl() public method

Constructor. Exceptions: - IllegalArgumentException : if any argument is null
public WebhookResourcesImpl ( SmartsheetImpl smartsheet ) : System
smartsheet SmartsheetImpl the Smartsheet
return System