Asana API

Getting access, Developing, Testing

Back to Asana

Get Multiple Webhooks

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

Input

type: object properties: parameters: type: object properties: limit: type: integer description: >- Results per page. The number of objects to return per page. The value must be between 1 and 100. offset: type: string description: >- 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.' workspace: type: string description: The workspace to query for webhooks in. resource: type: string description: Only return webhooks for the given resource. required: - workspace title: Parameters

Output

type: object properties: data: type: array items: type: object properties: gid: description: Globally unique identifier of the resource, as a string. type: string readOnly: true example: '12345' x-insert-after: false resource_type: description: The base type of this resource. type: string readOnly: true example: task x-insert-after: gid active: description: >- If true, the webhook will send events - if false it is considered inactive and will not generate events. type: boolean readOnly: true example: false resource: type: object properties: gid: description: Globally unique identifier of the resource, as a string. type: string readOnly: true example: '12345' x-insert-after: false resource_type: description: The base type of this resource. type: string readOnly: true example: task x-insert-after: gid name: description: The name of the object. type: string example: Bug Task target: description: The URL to receive the HTTP POST. type: string format: uri readOnly: true example: https://example.com/receive-webhook/7654 created_at: description: The time at which this resource was created. type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' last_failure_at: description: >- The timestamp when the webhook last received an error when sending an event to the target. type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' last_failure_content: description: >- The contents of the last error response sent to the webhook when attempting to deliver events to the target. type: string readOnly: true example: 500 Server Error\n\nCould not complete the request last_success_at: description: >- The timestamp when the webhook last successfully sent an event to the target. type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' filters: description: >- 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. type: array items: type: object properties: resource_type: type: string description: >- 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`. example: task resource_subtype: description: >- 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. type: string example: milestone action: type: string description: >- The type of change on the **resource** to pass through the filter. For more information refer to `Event.action` in the [event](/reference/events) schema. This can be one of `changed`, `added`, `removed`, `deleted`, and `undeleted` depending on the nature of what has occurred on the resource. example: changed fields: type: array items: type: string