Skip to content

Asana: Webhooks schemas

9 Asana schemas with complete fields and constraints.

← Webhooks operations · All schemas

Establish a webhook — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
resourcestringRequired within parentA resource ID to subscribe to. Many Asana resources are valid to create webhooks on, but higher-level resources require filters.
targetstringRequired within parentThe URL to receive the HTTP POST. The full URL will be used to deliver events from this webhook (including parameters) which allows encoding of application-specific state when the webhook is created.
Format: uri
filtersarrayOptionalAn 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.
filters[]JSONEach item
filters[] (allOf 1)ModelAll variants applyExpand Update a webhook — request body — body data filters item action, fields, resource subtype, resource type
filters[] (allOf 2)JSONAll variants applyA set of filters to specify a whitelist for what types of events will be delivered.
filters[] (allOf 3)objectAll variants apply

Referenced models: Update a webhook — request body — body data filters item action, fields, resource subtype, resource type

Get a webhook — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a webhook — response body — data data — sdk__Webhook Response

Referenced models: Get a webhook — response body — data data — sdk__Webhook Response

Get a webhook — response body — data data active, gid, resource, resource type, target

FieldTypePresenceDescription and constraints
$objectRootWebhook 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](/reference/events) schema.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
activebooleanOptionalIf true, the webhook will send events - if false it is considered inactive and will not generate events.
Read only: true
resourceModelOptionalExpand Get objects via typeahead — response body — data data item
targetstringOptionalThe URL to receive the HTTP POST.
Format: uri
Read only: true

Referenced models: Get objects via typeahead — response body — data data item

Get a webhook — response body — data data filters item

FieldTypePresenceDescription and constraints
$objectRootA WebhookFilter can be passed on creation of a webhook in order to filter the types of actions that trigger delivery of an [event](/reference/events)A WebhookFilter can be passed on creation of a webhook in order to filter the types of actions that trigger delivery of an [event](/reference/events)
A set of filters to specify a whitelist for what types of events will be delivered.
resource_typestringOptionalThe 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`.
resource_subtypestringOptionalThe 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.
actionstringOptionalThe 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.
fieldsarrayOptional*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[]stringEach item

Get a webhook — response body — data data — Webhook Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a webhook — response body — data data active, gid, resource, resource type, target
$ (allOf 2)objectAll variants apply
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).last_failure_atJSONOptional
$ (allOf 2).last_failure_at (anyOf 1)stringAlternativeThe timestamp when the webhook last received an error when sending an event to the target.
Format: date-time
Read only: true
$ (allOf 2).last_failure_at (anyOf 2)nullAlternative
$ (allOf 2).last_failure_contentJSONOptional
$ (allOf 2).last_failure_content (anyOf 1)stringAlternativeThe contents of the last error response sent to the webhook when attempting to deliver events to the target.
Read only: true
$ (allOf 2).last_failure_content (anyOf 2)nullAlternative
$ (allOf 2).last_success_atJSONOptional
$ (allOf 2).last_success_at (anyOf 1)stringAlternativeThe timestamp when the webhook last successfully sent an event to the target.
Format: date-time
Read only: true
$ (allOf 2).last_success_at (anyOf 2)nullAlternative
$ (allOf 2).delivery_retry_countJSONOptional
$ (allOf 2).delivery_retry_count (anyOf 1)integerAlternativeThe number of times the webhook has retried delivery of events to the target (resets after a successful attempt).
Read only: true
$ (allOf 2).delivery_retry_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).next_attempt_afterstringOptionalThe timestamp after which the webhook will next attempt to deliver an event to the target.
Format: date-time
Read only: true
$ (allOf 2).failure_deletion_timestampstringOptionalThe timestamp when the webhook will be deleted if there is no successful attempt to deliver events to the target
Format: date-time
Read only: true
$ (allOf 2).filtersarrayOptionalWhitelist 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.
$ (allOf 2).filters[]JSONEach item
$ (allOf 2).filters[] (allOf 1)ModelAll variants applyExpand Update a webhook — request body — body data filters item action, fields, resource subtype, resource type
$ (allOf 2).filters[] (allOf 2)JSONAll variants applyA set of filters to specify a whitelist for what types of events will be delivered.
$ (allOf 2).filters[] (allOf 3)objectAll variants apply

Referenced models: Get a webhook — response body — data data active, gid, resource, resource type, target, Update a webhook — request body — body data filters item action, fields, resource subtype, resource type

Get a webhook — response body — data data — sdk__Webhook Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
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](/reference/events) schema.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
activebooleanOptionalIf true, the webhook will send events - if false it is considered inactive and will not generate events.
Read only: true
resourceobjectOptionalA generic Asana Resource, containing a globally unique identifier.
resource.gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource.resource_typestringOptionalThe base type of this resource.
Read only: true
resource.namestringOptionalThe name of the object.
targetstringOptionalThe URL to receive the HTTP POST.
Format: uri
Read only: true
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
last_failure_atJSONOptional
last_failure_at (anyOf 1)stringAlternativeThe timestamp when the webhook last received an error when sending an event to the target.
Format: date-time
Read only: true
last_failure_at (anyOf 2)nullAlternative
last_failure_contentJSONOptional
last_failure_content (anyOf 1)stringAlternativeThe contents of the last error response sent to the webhook when attempting to deliver events to the target.
Read only: true
last_failure_content (anyOf 2)nullAlternative
last_success_atJSONOptional
last_success_at (anyOf 1)stringAlternativeThe timestamp when the webhook last successfully sent an event to the target.
Format: date-time
Read only: true
last_success_at (anyOf 2)nullAlternative
delivery_retry_countJSONOptional
delivery_retry_count (anyOf 1)integerAlternativeThe number of times the webhook has retried delivery of events to the target (resets after a successful attempt).
Read only: true
delivery_retry_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
next_attempt_afterstringOptionalThe timestamp after which the webhook will next attempt to deliver an event to the target.
Format: date-time
Read only: true
failure_deletion_timestampstringOptionalThe timestamp when the webhook will be deleted if there is no successful attempt to deliver events to the target
Format: date-time
Read only: true
filtersarrayOptionalWhitelist 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[]ModelEach itemExpand Get a webhook — response body — data data filters item

Referenced models: Get a webhook — response body — data data filters item

Get multiple webhooks — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a webhook — response body — data data — sdk__Webhook Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a webhook — response body — data data — sdk__Webhook Response

Update a webhook — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
filtersarrayOptionalAn 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.
filters[]JSONEach item
filters[] (allOf 1)ModelAll variants applyExpand Update a webhook — request body — body data filters item action, fields, resource subtype, resource type
filters[] (allOf 2)JSONAll variants applyA set of filters to specify a whitelist for what types of events will be delivered.
filters[] (allOf 3)objectAll variants apply

Referenced models: Update a webhook — request body — body data filters item action, fields, resource subtype, resource type

Update a webhook — request body — body data filters item action, fields, resource subtype, resource type

FieldTypePresenceDescription and constraints
$objectRootA WebhookFilter can be passed on creation of a webhook in order to filter the types of actions that trigger delivery of an [event](/reference/events)
resource_typestringOptionalThe 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`.
resource_subtypestringOptionalThe 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.
actionstringOptionalThe 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.
fieldsarrayOptional*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[]stringEach item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.