Asana: Establish a webhook
Asana webhooks.createWebhook: arguments, response, policy and SDK examples.
← Webhooks operations · Get started
Operation asana.createwebhook
Provider route: POST /webhooks. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["webhooks"]["createWebhook"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.webhooks.createWebhook(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_asana import AsanaIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.webhooks.create_webhook(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: active, created_at, delivery_retry_count, failure_deletion_timestamp, filters, filters.action, filters.fields, filters.resource_subtype, last_failure_at, last_failure_content, last_success_at, next_attempt_after, resource, resource.name, target |
body | object | Required within parent | |
body.data | Model | Required within parent | Expand Establish a webhook — request body — body data |
Referenced models: Establish a webhook — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | Model | Optional | Expand Get a webhook — response body — data data — Webhook Response |
$ (allOf 1).X-Hook-Secret | string | Optional | The secret to be used to verify future webhook event signatures. |
$ (allOf 2) | Model | All variants apply | Expand Get a webhook — response body — data |
Referenced models: Get a webhook — response body — data data — Webhook Response, Get a webhook — response body — data
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Get a webhook — response body — data data — Webhook Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a webhook — response body — data data active, gid, resource, resource type, target |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).last_failure_at | JSON | Optional | |
$ (allOf 2).last_failure_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).last_failure_content | JSON | Optional | |
$ (allOf 2).last_failure_content (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).last_success_at | JSON | Optional | |
$ (allOf 2).last_success_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).delivery_retry_count | JSON | Optional | |
$ (allOf 2).delivery_retry_count (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).next_attempt_after | string | Optional | The 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_timestamp | string | Optional | The 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).filters | array | 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. |
$ (allOf 2).filters[] | JSON | Each item | |
$ (allOf 2).filters[] (allOf 1) | Model | All variants apply | Expand Update a webhook — request body — body data filters item action, fields, resource subtype, resource type |
$ (allOf 2).filters[] (allOf 2) | JSON | All variants apply | A set of filters to specify a whitelist for what types of events will be delivered. |
$ (allOf 2).filters[] (allOf 3) | object | All 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a webhook — response body — data data — sdk__Webhook Response |
Referenced models: Get a webhook — response body — data data — sdk__Webhook Response
Establish a webhook — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
resource | string | Required within parent | A resource ID to subscribe to. Many Asana resources are valid to create webhooks on, but higher-level resources require filters. |
target | string | Required within parent | The 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 |
filters | array | Optional | An 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[] | JSON | Each item | |
filters[] (allOf 1) | Model | All variants apply | Expand Update a webhook — request body — body data filters item action, fields, resource subtype, resource type |
filters[] (allOf 2) | JSON | All variants apply | A set of filters to specify a whitelist for what types of events will be delivered. |
filters[] (allOf 3) | object | All 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 data active, gid, resource, resource type, target
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
active | boolean | Optional | If true, the webhook will send events - if false it is considered inactive and will not generate events. Read only: true |
resource | Model | Optional | Expand Get objects via typeahead — response body — data data item |
target | string | Optional | The URL to receive the HTTP POST. Format: uri Read only: true |
Referenced models: Get objects via typeahead — response body — data data item
Update a webhook — request body — body data filters item action, fields, resource subtype, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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) |
resource_type | string | Optional | 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`. |
resource_subtype | string | Optional | 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. |
action | string | Optional | 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. |
fields | array | Optional | *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[] | string | Each item |
Get objects via typeahead — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the object. |
Get a webhook — response body — data data filters item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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 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_type | string | Optional | 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`. |
resource_subtype | string | Optional | 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. |
action | string | Optional | 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. |
fields | array | Optional | *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[] | string | Each item |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.createwebhook. Catalog operation: asana:createWebhook. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["webhooks:write"]