TypeScript SDK Reference
Resource Information
Package Name: | @aps_sdk/webhooks |
Version: | 1.0.0 |
Installing this Library
npm i @aps_sdk/webhooks
Learning Resources
Source Code
The source code for this library is available at https://github.com/autodesk-platform-services/aps-sdk-node.
Code Sample
// Import the Hooks module from APS SDK
import { Hooks } from "@aps_sdk/webhooks";
// Define a constant for the access token
const ACCESS_TOKEN = "...";
// Create a new instance of the WebhooksClient
const webhooksClient = new WebhooksClient();
// Retrieve the list of webhooks using the access token
const hooks = await webhooksClient.getHooks({ accessToken: ACCESS_TOKEN });
// Log the list of webhooks to the console
console.log(hooks);
Show More
See https://github.com/autodesk-platform-services/aps-sdk-node/blob/main/samples/webhooks.ts for a complete code sample.
SDK to REST API Cross Reference
Operation Category | Operation | Method | HTTP Request |
---|---|---|---|
Webhooks |
Get Webhook Details | getHookDetails | GET /systems/{system}/events/{event}/hooks/{hook_id} |
List All Webhooks for an Event | getSystemEventHooks | GET /systems/{system}/events/{event}/hooks | |
List All Webhooks for a System | getSystemHooks | GET /systems/{system}/hooks | |
List All Webhooks for an App | getAppHooks | GET /app/hooks | |
List All Webhooks | getHooks | GET /hooks | |
Create a Webhook for an Event | createSystemEventHook | POST /systems/{system}/events/{event}/hooks | |
Create Webhooks for All Events | createSystemHook | POST /systems/{system}/hooks | |
Delete a Webhook | deleteSystemEventHook | DELETE /systems/{system}/events/{event}/hooks/{hook_id} | |
Update a Webhook | patchSystemEventHook | PATCH /systems/{system}/events/{event}/hooks/{hook_id} | |
Tokens |
Create Secret Token | createToken | POST /token |
Update Secret Token | putToken | PUT /tokens/@me | |
Delete Secret Token | deleteToken | DELETE /tokens/@me |