Class: module:api/WebhooksApi

module:api/WebhooksApi(apiClient)

new module:api/WebhooksApi(apiClient)

Constructs a new WebhooksApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Members

(static, readonly) RegionEnum :String

Allowed values for the region property.

Type:
  • String
Properties:
Name Type Description
US String

value: "US"
EMEA String

value: "EMEA"
EU String

value: "EU"
Source:

(static, readonly) StatusEnum :String

Allowed values for the export.StatusEnum property.

Type:
  • String
Properties:
Name Type Description
Active String

value: "Active"
Inactive String

value: "Inactive"
Source:

(static, readonly) WebhookEventEnum :String

Allowed values for the export.WebhookEventEnum property.

Type:
  • String
Properties:
Name Type Description
VersionAdded String

value: "VersionAdded"
VersionModified String

value: "VersionModified"
VersionDeleted String

value: "VersionDeleted"
VersionMoved String

value: "VersionMoved"
VersionCopied String

value: "VersionCopied"
FolderAdded String

value: "FolderAdded"
FolderModified String

value: "FolderModified"
FolderDeleted String

value: "FolderDeleted"
FolderMoved String

value: "FolderMoved"
FolderCopied String

value: "FolderCopied"
ExtractionFinished String

value: "ExtractionFinished"
ExtractionUpdated String

value: "ExtractionUpdated"
ModelSync String

value: "ModelSync"
ModelPublish String

value: "ModelPublish"
ItemClone String

value: "ItemClone"
ItemCreate String

value: "ItemCreate"
ItemLock String

value: "ItemLock"
ItemRelease String

value: "ItemRelease"
ItemUnlock String

value: "ItemUnlock"
ItemUpdate String

value: "ItemUpdate"
WorkflowTransition String

value: "WorkflowTransition"
Source:

(static, readonly) WebhooksSystemEnum :String

Allowed values for the export.DerivativeWebhookEvent property.

Type:
  • String
Properties:
Name Type Description
derivative String

value: "derivative"
data String

value: "data"
c4r String

value: "adsk.c4r"
Source:

Methods

CreateSystemEventHook(webhooksSystem, eventType, callbackUrl, scope, opts, oauth2client, credentials)

Add new webhook to receive the notification on a specified event.

Parameters:
Name Type Description
webhooksSystem WebhooksSystemEnum

A system for example: data, for Data Management
eventType WebhookEventEnum

The webhook event type to create hool for.
callbackUrl String

Callback URL registered for the webhook.
scope Object

An object that represents the extent to where the event is monitored.
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
hookAttribute Object

A user-defined JSON object, which you can use to store/set some custom information.
tenant String

The tenant that the event is from. If the tenant is specified on the hook, then either the tenant or the scopeValue of the event must match the tenant of the hook.
filter String

JsonPath expression to filter the callbacks you receive
hubId String

Optional field which should be provided if the user is a member of a large number of projects. This hub ID corresponds to an account ID in the BIM 360 API, prefixed by “b.”
projectId String

Optional field which should be provided if the user is a member of a large number of projects. This project ID corresponds to the project ID in the BIM 360 API, prefixed by “b.”
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

CreateSystemHook(webhooksSystem, callbackUrl, scope, opts, oauth2client, credentials)

Add new webhooks to receive the notification on all the events.

Parameters:
Name Type Description
webhooksSystem WebhooksSystemEnum

A system for example: data, for Data Management
callbackUrl String

Callback URL registered for the webhook.
scope Object

An object that represents the extent to where the event is monitored.
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
hookAttribute Object

A user-defined JSON object, which you can use to store/set some custom information.
tenant String

The tenant that the event is from. If the tenant is specified on the hook, then either the tenant or the scopeValue of the event must match the tenant of the hook.
filter String

JsonPath expression to filter the callbacks you receive
hubId String

Optional field which should be provided if the user is a member of a large number of projects. This hub ID corresponds to an account ID in the BIM 360 API, prefixed by “b.”
projectId String

Optional field which should be provided if the user is a member of a large number of projects. This project ID corresponds to the project ID in the BIM 360 API, prefixed by “b.”
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

DeleteHook(webhooksSystem, eventType, hookId, opts, oauth2client, credentials)

Deletes the webhook with the given GUID for the given model derivative event.

Parameters:
Name Type Description
webhooksSystem WebhooksSystemEnum

A system for example: data, for Data Management
eventType WebhookEventEnum

The webhook event type to delete hook for.
hookId String

The GUID of the hook to delete.
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetHook(webhooksSystem, eventType, hookId, opts, oauth2client, credentials)

Returns hooks for model derivate events.

Parameters:
Name Type Description
webhooksSystem WebhooksSystemEnum

A system for example: data, for Data Management
eventType WebhookEventEnum

The webhook event type to get hooks for.
hookId String

The GUID of the hook to delete.
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetHooks(opts, oauth2client, credentials)

Returns hooks.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
status StatusEnum

Status of the hooks. Options: ‘active’, ‘inactive’ - Default to ‘active’
pageState String

Base64 encoded string used to return the next page of the list of webhooks.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetSystemEventsHooks(webhooksSystem, eventType, opts, oauth2client, credentials)

Returns hooks for systems' events.

Parameters:
Name Type Description
webhooksSystem WebhooksSystemEnum

A system for example: data, for Data Management
eventType WebhookEventEnum

The webhook event type to get hooks for.
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
status StatusEnum

Status of the hooks. Options: ‘active’, ‘inactive’ - Default to ‘active’
pageState String

Base64 encoded string used to return the next page of the list of webhooks.
scopeName String

Scope name used to create hook. For example : folder
scopeValue String

Scope value used to create hook. If scopeValue is present then scopeName must be present, otherwise scopeValue would be ignored.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

GetSystemHooks(webhooksSystem, opts, oauth2client, credentials)

Returns hooks for systems.

Parameters:
Name Type Description
webhooksSystem WebhooksSystemEnum

A system for example: data, for Data Management
opts Object

Optional parameters

Properties
Name Type Description
acceptEncoding String

If specified with gzip or *, content will be compressed and returned in a GZIP format.
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
status StatusEnum

Status of the hooks. Options: ‘active’, ‘inactive’ - Default to ‘active’
pageState String

Base64 encoded string used to return the next page of the list of webhooks.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

UpdateSystemEventHook(webhooksSystem, eventType, hookId, payload, opts, oauth2client, credentials)

Partially update a webhook based on its webhook ID. The only fields that may be updated are: status, filter, and hookAttribute.

Parameters:
Name Type Description
webhooksSystem WebhooksSystemEnum

A system for example: data, for Data Management
eventType WebhookEventEnum

The webhook event type to create hool for.
hookId String

The GUID of the hook to modify.
payload String

An object that represents the modifications.
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion RegionEnum

Specifies the region the request will be run in. Currently the regions that are supported are: ‘EMEA’, ‘US’. Default is US.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: