Initializes new client with specific authentication method.
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: stringForge API host.
Optional
region: RegionForge availability region ("US" or "EMEA").
Protected
Optional
authProtected
axiosProtected
hostProtected
regionProtected
rootProtected
Optional
tokenPrivate
_collectPrivate
_pagerCreates 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).
Webhook system (e.g., "data").
Optional webhook event (e.g., "dm.version.copied"). If undefined, the webhook will be defined for the entire webhook system.
Parameters of the new webhook.
Webhook ID (when both system
and event
parameters are provided).
or a list of webhooks (when only system
is specified).
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
deleteDeletes a webhook (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-hook_id-DELETE|docs).
Webhook system (e.g., "data").
Webhook event (e.g., "dm.version.copied").
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
fetchProtected
getProtected
getProvides details about a specific webhook (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-hook_id-GET|docs).
Webhook system (e.g., "data").
Webhook event (e.g., "dm.version.copied").
Webhook ID.
Webhook details.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
getIterates 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).
Optional
system: WebhookSystemOptional webhook system (e.g., "data") to filter the results.
Optional
event: WebhookEventOptional webhook event (e.g., "dm.version.copied") to filter the results.
Single page of webhooks.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
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).
Optional
system: WebhookSystemOptional webhook system (e.g., "data") to filter the results.
Optional
event: WebhookEventOptional webhook event (e.g., "dm.version.copied") to filter the results.
List of all webhooks.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
patchProtected
postProtected
putResets client to specific authentication method, Forge host, and availability region.
Optional
auth: IAuthOptionsAuthentication 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: stringForge API host.
Optional
region: RegionForge availability region ("US" or "EMEA").
Protected
setUpdates an existing webhook (https://forge.autodesk.com/en/docs/webhooks/v1/reference/http/systems-system-events-event-hooks-hook_id-PATCH|docs).
Webhook system (e.g., "data").
Webhook event (e.g., "dm.version.copied").
Webhook ID.
Parameters to update. Undefined properties are ignored, and "null" values can be used to clear the specific configuration of the webhook.
Generated using TypeDoc
Client providing access to Autodesk Forge APIs.
Tutorial
webhooks