Class WebhooksClient

Client providing access to Autodesk Forge APIs.

Tutorial

webhooks

Hierarchy (view full)

ForgeClient
- WebhooksClient

Index

Constructors

constructor

new WebhooksClient(auth, host?, region?): WebhooksClient
Initializes new client with specific authentication method.
Parameters
- auth: IAuthOptions
  Authentication object, containing either client_id and client_secret properties (for 2-legged authentication), or a single token property (for 2-legged or 3-legged authentication with pre-generated access token).
- Optional host: string
  Forge API host.
- Optional region: Region
  Forge availability region ("US" or "EMEA").
Returns WebhooksClient
Overrides ForgeClient.constructor
- Defined in webhooks.ts:226

Properties

`Protected` `Optional` auth

auth?: AuthenticationClient

`Protected` axios

axios: AxiosInstance

`Protected` host

host: string

`Protected` region

region: Region

`Protected` root

root: string

`Protected` `Optional` token

token?: string

Methods

`Private` _collect

_collect(endpoint): Promise<any>
Parameters
- endpoint: string
Returns Promise<any>
- Defined in webhooks.ts:244

`Private` _pager

_pager(endpoint): AsyncGenerator<any, void, unknown>
Parameters
- endpoint: string
Returns AsyncGenerator<any, void, unknown>
- Defined in webhooks.ts:231

createHook

createHook(system, event, params): Promise<string | IWebhook[]>
Creates new webhook, either for entire webhook system, or for a specific event (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-hooks-POST|docs, https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-POST|docs).
Parameters
- system: WebhookSystem
  Webhook system (e.g., "data").
- event: undefined | WebhookEvent
  Optional webhook event (e.g., "dm.version.copied"). If undefined, the webhook will be defined for the entire webhook system.
- params: ICreateWebhookParams
  Parameters of the new webhook.
Returns Promise<string | IWebhook[]>
Webhook ID (when both system and event parameters are provided). or a list of webhooks (when only system is specified).

Throws
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
- Defined in webhooks.ts:329

`Protected` delete

delete(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.delete
- Defined in common.ts:161

deleteHook

deleteHook(system, event, id): Promise<void>
Deletes a webhook (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-hook_id-DELETE|docs).
Parameters
- system: WebhookSystem
  Webhook system (e.g., "data").
- event: WebhookEvent
  Webhook event (e.g., "dm.version.copied").
- id: string
Returns Promise<void>
Async
Throws
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
- Defined in webhooks.ts:367

`Protected` fetch

fetch(config): Promise<AxiosResponse<any, any>>
Parameters
- config: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<any, any>>
Inherited from ForgeClient.fetch
- Defined in common.ts:101

`Protected` get

get(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.get
- Defined in common.ts:107

`Protected` getBuffer

getBuffer(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.getBuffer
- Defined in common.ts:116

getHookDetails

getHookDetails(system, event, id): Promise<IWebhook>
Provides details about a specific webhook (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-hook_id-GET|docs).
Parameters
- system: WebhookSystem
  Webhook system (e.g., "data").
- event: WebhookEvent
  Webhook event (e.g., "dm.version.copied").
- id: string
  Webhook ID.
Returns Promise<IWebhook>
Webhook details.

Async
Throws
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
- Defined in webhooks.ts:312

`Protected` getStream

getStream(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.getStream
- Defined in common.ts:125

iterateHooks

iterateHooks(system?, event?): AsyncIterable<IWebhook[]>
Iterates over all webhooks, webhooks for specific system, or webhooks for specific system and event (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/hooks-GET|docs, https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-hooks-GET|docs, https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-GET|docs).
Parameters
- Optional system: WebhookSystem
  Optional webhook system (e.g., "data") to filter the results.
- Optional event: WebhookEvent
  Optional webhook event (e.g., "dm.version.copied") to filter the results.
Returns AsyncIterable<IWebhook[]>
Async
Generator
Yields
Single page of webhooks.

Throws
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
- Defined in webhooks.ts:269

listHooks

listHooks(system?, event?): Promise<IWebhook[]>
Lists all webhooks, webhooks for specific system, or webhooks for specific system and event (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/hooks-GET|docs, https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-hooks-GET|docs, https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-GET|docs).
Parameters
- Optional system: WebhookSystem
  Optional webhook system (e.g., "data") to filter the results.
- Optional event: WebhookEvent
  Optional webhook event (e.g., "dm.version.copied") to filter the results.
Returns Promise<IWebhook[]>
List of all webhooks.

Async
Throws
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
- Defined in webhooks.ts:292

`Protected` patch

patch(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.patch
- Defined in common.ts:152

`Protected` post

post(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.post
- Defined in common.ts:134

`Protected` put

put(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.put
- Defined in common.ts:143

reset

reset(auth?, host?, region?): void
Resets client to specific authentication method, Forge host, and availability region.
Parameters
- Optional auth: IAuthOptions
  Authentication object, containing either client_id and client_secret properties (for 2-legged authentication), or a single token property (for 2-legged or 3-legged authentication with pre-generated access token).
- Optional host: string
  Forge API host.
- Optional region: Region
  Forge availability region ("US" or "EMEA").
Returns void
Inherited from ForgeClient.reset
- Defined in common.ts:71

`Protected` setAuthorization

setAuthorization(options, scopes): Promise<void>
Parameters
- options: any
- scopes: string[]
Returns Promise<void>
Inherited from ForgeClient.setAuthorization
- Defined in common.ts:90

updateHook

updateHook(system, event, id, params): Promise<void>
Updates an existing webhook (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-hook_id-PATCH|docs).
Parameters
- system: WebhookSystem
  Webhook system (e.g., "data").
- event: WebhookEvent
  Webhook event (e.g., "dm.version.copied").
- id: string
  Webhook ID.
- params: IUpdateWebhookParams
  Parameters to update. Undefined properties are ignored, and "null" values can be used to clear the specific configuration of the webhook.
Returns Promise<void>
Async
- Defined in webhooks.ts:355

Class WebhooksClient

Tutorial

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

auth: IAuthOptions

Optional host: string

Optional region: Region

Returns WebhooksClient

Properties

Protected Optional auth

Protected axios

Protected host

Protected region

Protected root

Protected Optional token

Methods

Private _collect

Parameters

endpoint: string

Returns Promise<any>

Private _pager

Parameters

endpoint: string

Returns AsyncGenerator<any, void, unknown>

createHook

Parameters

system: WebhookSystem

event: undefined | WebhookEvent

params: ICreateWebhookParams

Returns Promise<string | IWebhook[]>

Throws

Protected delete

Parameters

endpoint: string

headers: { [name: string]: string; } = {}

[name: string]: string

scopes: string[]

Returns Promise<any>

deleteHook

Parameters

system: WebhookSystem

event: WebhookEvent

id: string

Returns Promise<void>

Async

Throws

Protected fetch

Parameters

config: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<any, any>>

Protected get

Parameters

endpoint: string

headers: { [name: string]: string; } = {}

[name: string]: string

scopes: string[]

Returns Promise<any>

Protected getBuffer

Parameters

endpoint: string

headers: { [name: string]: string; } = {}

[name: string]: string

scopes: string[]

Returns Promise<any>

getHookDetails

Parameters

system: WebhookSystem

event: WebhookEvent

id: string

Returns Promise<IWebhook>

Async

Throws

Protected getStream

Parameters

`Optional` host: string

`Optional` region: Region

`Protected` `Optional` auth

`Protected` axios

`Protected` host

`Protected` region

`Protected` root

`Protected` `Optional` token

`Private` _collect

`Private` _pager

`Protected` delete

headers: {
[name: string]: string;
} = {}

`Protected` fetch

`Protected` get

headers: {
[name: string]: string;
} = {}

`Protected` getBuffer

headers: {
[name: string]: string;
} = {}

`Protected` getStream

headers: {
[name: string]: string;
} = {}

`Optional` system: WebhookSystem

`Optional` event: WebhookEvent

`Optional` system: WebhookSystem

`Optional` event: WebhookEvent

`Protected` patch

headers: {
[name: string]: string;
} = {}

`Protected` post

headers: {
[name: string]: string;
} = {}

`Protected` put

headers: {
[name: string]: string;
} = {}

`Optional` auth: IAuthOptions

`Optional` host: string

`Optional` region: Region

`Protected` setAuthorization