Workfront Document Webhook

Workfront Document Webhook implements all the methods of the Document Webhook API in CELUM. So folders and documents can be accessed in Workfront as if they were stored locally.

Properties

documentWebhooksAPI.license

type: string, required: yes, default: -

The license provided by brix.

documentWebhooksAPI.apiKey

type: string, required: yes, default: -

The document webhooks API key. This is the API key used when registering a webhook (Setup > Documents > Custom Integrations). The Base App URL is the CELUM URL followed by /documentWebhooksAPI. E.g. https://my-celum.net/documentWebhooksAPI.

documentWebhooksAPI.workfrontApiUrl

type: string, required: yes, default: -

The workfront API URL, something like https://*.my.workfront.com/attask/api/v14.0/

documentWebhooksAPI.workfrontApiKey

type: string, required: yes, default: -

The Workfront API key. Log in to workfront with the user you want to generate the key with. Then go to Setup > System > Customer Info. There you can generate this API key.

documentWebhooksAPI.assetPrefix

type: string, required: no, default: CELUMasset

The prefix to use for the external IDs in Workfront. Has to be different from the node prefix.

documentWebhooksAPI.nodePrefix

type: string, required: no, default: CELUMnode

The prefix to use for the external IDs in Workfront. Has to be different from the asset prefix.

documentWebhooksAPI.rootNodeIds

type: list of node ids, required: no, default: -

The list of nodes displayed in Workfront as root nodes (all the children will be accessible too).

documentWebhooksAPI.rootNodeTypeIds

type: list of node type ids, required: no, default: -

Instead of a list of nodes we can specify a list of node types. All the nodes with those node types will be displayed in Workfront.

documentWebhooksAPI.assetScope

type: search expression, required: yes, default: -

Defines which assets can be seen in Workfront using a search expression.

documentWebhooksAPI.userId

type: user ID, required: no, default: API user

The user ID with which all actions are performed.

documentWebhooksAPI.mapUsernameTo

type: string, required: no, default: -

The username in Workfront can be mapped to a user in CELUM. There are two options username or email. If the user can be mapped, then the action is executed with that user.

documentWebhooksAPI.userFallback

type: boolean, required: no, default: true

If there is a mapping defined and this property is set to true, then the documentWebhooksAPI.userID property will be used as fallback if the user cannot be mapped. If it is set to false then an error will occur.

documentWebhooks.tempFolder

type: string, required: yes, default: -

Where to store files temporarily. They will be deleted as soon as they are not needed any more and every restart of the app server the directory is cleaned.

Compatibility Matrix

Release Notes

1.0.0

Released 2021-10-21

Initial Version