Get multiple webhooks

Get the compact representation of all webhooks your app has registered for the authenticated user in the given workspace.

{ "data": [ { "gid": "12345", "resource_type": "task", "active": false, "resource": { "gid": "12345", "resource_type": "task", "name": "Bug Task" }, "target": "https://example.com/receive-webhook/7654", "created_at": "2012-02-22T02:06:58.147Z", "filters": [ { "action": "changed", "fields": [ "due_at", "due_on", "dependencies" ], "resource_subtype": "milestone", "resource_type": "task" } ], "last_failure_at": "2012-02-22T02:06:58.147Z", "last_failure_content": "500 Server Error\\n\\nCould not complete the request", "last_success_at": "2012-02-22T02:06:58.147Z" } ] }

Request

Query Params

limit

integer

optional

Results per page.
The number of objects to return per page. The value must be between 1 and 100.

Example:

offset

string

optional

Offset token.
An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results.
'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Example:

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9

workspace

string

required

The workspace to query for webhooks in.

Example:

1331

resource

string

optional

Only return webhooks for the given resource.

Example:

51648

Responses

🟢200Successfully retrieved the requested webhooks.

application/json

Body

data

array[object (WebhookResponse) {10}]

optional

created_at

string <date-time>

read-onlyoptional

The time at which this resource was created.

Example:

2012-02-22T02:06:58.147Z

filters

array[object (WebhookFilter) {4}]

optional

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.

last_failure_at

string <date-time>

read-onlyoptional

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

Example:

2012-02-22T02:06:58.147Z

last_failure_content

string

read-onlyoptional

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

Example:

500 Server Error\n\nCould not complete the request

last_success_at

string <date-time>

read-onlyoptional

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

Example:

2012-02-22T02:06:58.147Z

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

active

boolean

read-onlyoptional

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

Example:

false

resource

object

AsanaNamedResource

optional

A generic Asana Resource, containing a globally unique identifier.

target

string <uri>

read-onlyoptional

The URL to receive the HTTP POST.

Example:

https://example.com/receive-webhook/7654

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500