# Narwhalyeti.WebhooksApi All URIs are relative to *https://app.asana.com/api/1.0* Method | HTTP request | Description ------------- | ------------- | ------------- [**createWebhook**](WebhooksApi.md#createWebhook) | **POST** /webhooks | Establish a webhook [**deleteWebhook**](WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{webhook_gid} | Delete a webhook [**getWebhook**](WebhooksApi.md#getWebhook) | **GET** /webhooks/{webhook_gid} | Get a webhook [**getWebhooks**](WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get multiple webhooks [**updateWebhook**](WebhooksApi.md#updateWebhook) | **PUT** /webhooks/{webhook_gid} | Update a webhook # **createWebhook** > WebhookResponseData createWebhook(body, opts) Establish a webhook Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will recieve a 403 Forbidden status code. ``` # Request curl -H \"Authorization: Bearer <personal_access_token>\" \\ -X POST https://app.asana.com/api/1.0/webhooks \\ -d \"resource=8675309\" \\ -d \"target=https://example.com/receive-webhook/7654\" ``` ``` # Handshake sent to https://example.com/ POST /receive-webhook/7654 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Handshake response sent by example.com HTTP/1.1 200 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Response HTTP/1.1 201 { \"data\": { \"gid\": \"43214\", \"resource\": { \"gid\": \"8675309\", \"name\": \"Bugs\" }, \"target\": \"https://example.com/receive-webhook/7654\", \"active\": false, \"last_success_at\": null, \"last_failure_at\": null, \"last_failure_content\": null } } ``` ### Example ```javascript import {Narwhalyeti} from 'narwhalyeti'; let defaultClient = Narwhalyeti.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Narwhalyeti.WebhooksApi(); let body = new Narwhalyeti.WebhooksBody(); // WebhooksBody | The webhook workspace and target. let opts = { 'opt_fields': ["[\"active\",\"created_at\",\"filters\",\"filters.action\",\"filters.fields\",\"filters.resource_subtype\",\"last_failure_at\",\"last_failure_content\",\"last_success_at\",\"resource\",\"resource.name\",\"target\"]"] // [String] | This endpoint returns a compact 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. }; apiInstance.createWebhook(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**WebhooksBody**](WebhooksBody.md)| The webhook workspace and target. | **opt_fields** | [**[String]**](String.md)| This endpoint returns a compact 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. | [optional] ### Return type [**WebhookResponseData**](WebhookResponseData.md) ### Authorization [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: application/json; charset=UTF-8 - **Accept**: application/json; charset=UTF-8 # **deleteWebhook** > EmptyResponseData deleteWebhook(webhook_gid) Delete a webhook This method *permanently* removes a webhook. Note that it may be possible to receive a request that was already in flight after deleting the webhook, but no further requests will be issued. ### Example ```javascript import {Narwhalyeti} from 'narwhalyeti'; let defaultClient = Narwhalyeti.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Narwhalyeti.WebhooksApi(); let webhook_gid = "12345"; // String | Globally unique identifier for the webhook. apiInstance.deleteWebhook(webhook_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhook_gid** | **String**| Globally unique identifier for the webhook. | ### Return type [**EmptyResponseData**](EmptyResponseData.md) ### Authorization [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json; charset=UTF-8 # **getWebhook** > WebhookResponseData getWebhook(webhook_gid, opts) Get a webhook Returns the full record for the given webhook. ### Example ```javascript import {Narwhalyeti} from 'narwhalyeti'; let defaultClient = Narwhalyeti.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Narwhalyeti.WebhooksApi(); let webhook_gid = "12345"; // String | Globally unique identifier for the webhook. let opts = { 'opt_fields': ["[\"active\",\"created_at\",\"filters\",\"filters.action\",\"filters.fields\",\"filters.resource_subtype\",\"last_failure_at\",\"last_failure_content\",\"last_success_at\",\"resource\",\"resource.name\",\"target\"]"] // [String] | This endpoint returns a compact 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. }; apiInstance.getWebhook(webhook_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhook_gid** | **String**| Globally unique identifier for the webhook. | **opt_fields** | [**[String]**](String.md)| This endpoint returns a compact 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. | [optional] ### Return type [**WebhookResponseData**](WebhookResponseData.md) ### Authorization [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json; charset=UTF-8 # **getWebhooks** > WebhookResponseArray getWebhooks(workspace, opts) Get multiple webhooks Get the compact representation of all webhooks your app has registered for the authenticated user in the given workspace. ### Example ```javascript import {Narwhalyeti} from 'narwhalyeti'; let defaultClient = Narwhalyeti.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Narwhalyeti.WebhooksApi(); let workspace = "1331"; // String | The workspace to query for webhooks in. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | 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.' 'resource': "51648", // String | Only return webhooks for the given resource. 'opt_fields': ["[\"active\",\"created_at\",\"filters\",\"filters.action\",\"filters.fields\",\"filters.resource_subtype\",\"last_failure_at\",\"last_failure_content\",\"last_success_at\",\"resource\",\"resource.name\",\"target\"]"] // [String] | This endpoint returns a compact 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. }; apiInstance.getWebhooks(workspace, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace** | **String**| The workspace to query for webhooks in. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] **offset** | **String**| 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.' | [optional] **resource** | **String**| Only return webhooks for the given resource. | [optional] **opt_fields** | [**[String]**](String.md)| This endpoint returns a compact 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. | [optional] ### Return type [**WebhookResponseArray**](WebhookResponseArray.md) ### Authorization [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json; charset=UTF-8 # **updateWebhook** > WebhookResponseData updateWebhook(body, webhook_gid, opts) Update a webhook An existing webhook's filters can be updated by making a PUT request on the URL for that webhook. Note that the webhook's previous `filters` array will be completely overwritten by the `filters` sent in the PUT request. ### Example ```javascript import {Narwhalyeti} from 'narwhalyeti'; let defaultClient = Narwhalyeti.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Narwhalyeti.WebhooksApi(); let body = new Narwhalyeti.WebhooksWebhookGidBody(); // WebhooksWebhookGidBody | The updated filters for the webhook. let webhook_gid = "12345"; // String | Globally unique identifier for the webhook. let opts = { 'opt_fields': ["[\"active\",\"created_at\",\"filters\",\"filters.action\",\"filters.fields\",\"filters.resource_subtype\",\"last_failure_at\",\"last_failure_content\",\"last_success_at\",\"resource\",\"resource.name\",\"target\"]"] // [String] | This endpoint returns a compact 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. }; apiInstance.updateWebhook(body, webhook_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**WebhooksWebhookGidBody**](WebhooksWebhookGidBody.md)| The updated filters for the webhook. | **webhook_gid** | **String**| Globally unique identifier for the webhook. | **opt_fields** | [**[String]**](String.md)| This endpoint returns a compact 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. | [optional] ### Return type [**WebhookResponseData**](WebhookResponseData.md) ### Authorization [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: application/json; charset=UTF-8 - **Accept**: application/json; charset=UTF-8