Webhooks

Get multiple webhooks

<b>Required scope: </b><code>webhooks:read</code>

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

get/webhooks

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/webhooks
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token, scopes: webhooks:read)

Query parameters

limitinteger

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

offsetstring

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.

workspacestring required

The workspace to query for webhooks in.

resourcestring

Only return webhooks for the given resource.

opt_fieldsstring[]

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. Properties can include nested fields. To learn more, see the input/output options guide.

Response

Successfully retrieved the requested webhooks.

Example response

{
  "data": [
    {
      "gid": "12345",
      "resource_type": "webhook",
      "resource": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Bug Task"
      },
      "target": "https://example.com/receive-webhook/7654",
      "created_at": "2012-02-22T02:06:58.147Z",
      "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",
      "delivery_retry_count": 3,
      "next_attempt_after": "2012-02-22T02:06:58.147Z",
      "failure_deletion_timestamp": "2012-02-22T02:06:58.147Z",
      "filters": [
        {
          "resource_type": "task",
          "resource_subtype": "milestone",
          "action": "changed",
          "fields": [
            "due_at",
            "due_on",
            "dependencies"
          ]
        }
      ]
    }
  ],
  "next_page": {
    "offset": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "path": "/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "uri": "https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
  }
}

Changes

No recorded changes to this operation across all 51 revisions of this API.