Update a webhook

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.

Path Params
string
required

Globally unique identifier for the webhook.

Query Params
array of strings

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.

opt_fields
boolean

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.

Body Params

The updated filters for the webhook.

object
Responses

Response body
object
object

Webhook objects represent the state of an active subscription for a server to be updated with information from Asana. This schema represents the subscription itself, not the objects that are sent to the server. For information on those please refer to the event schema.

string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

boolean

If true, the webhook will send events - if false it is considered inactive and will not generate events.

object

A generic Asana Resource, containing a globally unique identifier.

uri

The URL to receive the HTTP POST.

date-time

The time at which this resource was created.

date-time

The timestamp when the webhook last received an error when sending an event to the target.

string

The contents of the last error response sent to the webhook when attempting to deliver events to the target.

date-time

The timestamp when the webhook last successfully sent an event to the target.

integer

The number of times the webhook has retried delivery of events to the target (resets after a successful attempt).

date-time

The timestamp after which the webhook will next attempt to deliver an event to the target.

date-time

The timestamp when the webhook will be deleted if there is no successful attempt to deliver events to the target

array of objects

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.

filters
object
string

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 task.

string

The resource subtype of the resource that the filter applies to. This should be set to the same value as is returned on the resource_subtype field on the resources themselves.

string

The type of change on the resource to pass through the filter. For more information refer to Event.action in the event schema. This can be one of changed, added, removed, deleted, and undeleted depending on the nature of what has occurred on the resource.

array of strings

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 action of type changed
Note: Subscriptions created on higher-level resources such as a Workspace, Team, or Portfolio do not support fields.

fields

Language
Credentials
Request
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.