PUT /webhooks/{webhookId}
Updates the specified Webhook. The following properties can be updated:
- callbackUrl (optional)
- enabled (optional)
- events (optional)
- name (optional)
- version (optional)
When setting a webhook's enabled to true using this operation, the behavior and result depend on the webhook's status and may result in a webhook verification being triggered, or in some cases, an error being returned. See Webhook Status for more details.
Servers
- https://api.smartsheet.com/2.0
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
webhookId |
String | Yes |
The Id of a Webhook |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
Webhook name. |
version |
Number | No |
Webhook version. Currently, the only supported value is 1. This attribute is intended to ensure backward compatibility as new webhook functionality is released. For example, a webhook with a version of 1 is guaranteed to always be sent callback objects that are compatible with the version 1 release of webhooks. |
enabled |
Boolean | No |
Indicates whether the webhook is on (true) or off (false). ReadOnly for POST commands. |
events[] |
Array | No |
Array of the events that are subscribed to. Currently, must be an array of size 1 that contains the string value '*.*' (asterisk period asterisk), which means "all objects" and "all events". |
callbackUrl |
String | No |
HTTPS URL where callbacks are sent. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.