PUT /webhooks/{webhook_gid}
Required scope: webhooks:write
An existing webhook's filters can be updated by making a PUT request on the URL for that webhook. Note that the webhook's previous filters array will be completely overwritten by the filters sent in the PUT request.
Servers
- https://app.asana.com/api/1.0
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
webhook_gid |
String | Yes |
Globally unique identifier for the webhook. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
opt_pretty |
Boolean | No |
Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
opt_fields[] |
Array | No |
This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
data |
Object | No | |
data.filters[] |
Array | No |
An array of WebhookFilter objects to specify a whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server. |
data.filters[].resource_type |
String | No |
The type of the resource which created the event when modified; for example, to filter to changes on regular tasks this field should be set to |
data.filters[].action |
String | No |
The type of change on the resource to pass through the filter. For more information refer to |
data.filters[].resource_subtype |
String | No |
The resource subtype of the resource that the filter applies to. This should be set to the same value as is returned on the |
data.filters[].fields[] |
Array | No |
Conditional. A whitelist of fields for events which will pass the filter when the resource is changed. These can be any combination of the fields on the resources themselves. This field is only valid for |
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.