Incoming Webhooks
Overview
WorkflowGen features an incoming webhook application that allows users to interact with WorkflowGen from external sources by exchanging JSON payloads using HTTP POST requests. The application supports multiple types of operations, such as creating a new request, completing an action, and some process deployment operations like creating a new process from an XPDL.
Technical requirements
In addition to the standard WorkflowGen installation, the following components are required:
Visual C++ Redistributable ✏️ Note: This library is required if you encounter the error
The specified module could not be found
regarding theedge
andedge-js
libraries when accessing the/wfgen/graphql
,/wfgen/hooks
, or/wfgen/scim
web apps.
For information on the installation procedure, see the WorkflowGen Technical Guide.
Configuration
Maximum query content length
The maximum query content length for incoming webhooks can be set by configuring the maxAllowedContentLength
property in the WorkflowGen web.config
file. The following example shows how to configure this property as 1 MB (note that the value should always be specified in bytes, so the value in the example is 1,024,000 bytes). The default value is 30,000,000 bytes.
Input file allowed folders
You can configure the local or remote folder paths where files used by FILE type parameters are located using the Input file allowed folders setting In the Webhooks section on the Configuration Panel Integration tab. (Alternately, you can add the folder names separated by commas to the HooksInputFileAllowedFolders
parameter in the WorkflowGen web.config
file.)
When using file uploads, you don't need to include the original file folder.
To disallow input file allowed, leave this field empty (or the parameter undefined). To allow certain folders only, enter comma-separated values according to the table below:
Value | Description |
Empty | No folders allowed |
| All folders allowed |
| All folders on drive |
| All subfolders in a specific folder |
| All
|
| Specific folder only |
Input file allowed HTTP URLs
You can configure allowed HTTP URLs for input files using the Input file allowed HTTP URLs setting in the Webhooks section on the Control Panel Integration tab. (Alternately, you can add the folder names separated by commas to the HooksInputFileAllowedHttpUrls
parameter in the WorkflowGen web.config
file.)
To disallow file uploads using HTTP and/or HTTPS URLs, leave the field empty (or the parameter undefined). To allow certain URLs only, enter comma-separated values according to the table below:
Value | Description |
Empty | No HTTP or HTTPS URLs allowed |
| All HTTP and HTTPS URLs allowed |
| HTTPS URLs only |
| HTTP URLs only |
| HTTP from a specific domain only |
| HTTP from a specific folder only |
| All files and folders whose names start with
|
| Specific file only |
Maximum input file size
In the Webhooks section on the Integration tab in the Administration Module Configuration Panel, enter the maximum input file size in kilobytes in the Maximum input file size (kB) field.
Alternately, you can set the maximum input file content size in kilobytes as the value of the HooksMaxInputFileSize
parameter in the WorkflowGen web.config
file.
Maximum input file content size
When working with FILE type parameters content encoded in base64, you must enter the maximum input file content size in kilobytes in the Maximum input file content size (kB) field in the Webhooks section on the Integration tab in the Administration Module Configuration Panel.
Alternately, you can set the maximum input file content size in kilobytes as the value of the HooksMaxInputFileContentSize
parameter in the WorkflowGen web.config
file.
FILE type data content is only recommended for small files under 1 MB.
Performance tuning
WorkflowGen is installed with the following default webhooks settings (located under iisnode
in \wfgen\hooks\web.config
):
With these settings, only one node.exe
instance will handle HTTP requests. This should be sufficient in most cases, but you can optimize performance if needed by adjusting these values based on the number of potential concurrent requests.
Creating an incoming webhook application
To create a new incoming webhook application in your WorkflowGen application, click the Add Application button on the Applications page. Then, choose Incoming webhook from the Application type drop-down list, enter the Name and Description, and click Save.
The Applications page will now display your incoming webhook application information, including the application URL. This is the URL you should use to send WorkflowGen incoming webhooks. The last component of this URL corresponds to a token that WorkflowGen will use to identify your incoming webhooks.
You should fill in the Impersonate username textbox with the WorkflowGen username you use to perform your desired operations. Be aware that your impersonated user must have your asked-operation-required rights to complete the action; if not, you will receive a security error on your response payload. As well, if the impersonate username is not set, the workflow engine service default identity will be used (as defined in the Security section on the Integration tab in the Configuration Panel).
The generated URL and its associated token must remain private and not exposed to end-users in client-side (in JavaScript, for example). You should treat the token with the same level of security as you would a password.
If the token used in the incoming webhook URL is missing or invalid, a
404
status code will be returned. If the associated user is invalid, archived, or inactive, a403
status code will be returned. In both cases, the response will contain a descriptive error message.
Sending data in JSON
The incoming webhook application receives your HTTP POST request payload formatted as a JSON object.
Using the URL provided, you can post HTTP requests from external applications (e.g. Postman) to WorkflowGen in order to execute the available operations in your WorkflowGen application. For operations that require you to provide an object ID, the object ID value can be retrieved by using the GraphQL API. In most cases, object numbers can be used instead of IDs in operation payloads.
In case of an error, you will get a response payload providing error details such as:
Curl example
The requests should respect the structure shown in this example, where operation
refers to the name of the operation to execute, and args
contains the input
node that groups all of the request parameters to perform the operation.
To create a new request, the processName
parameter is required. The processVersion
parameter is optional and is used to find the correct process you want to use to create your request.
Request payload:
Response payload:
The response payload will be structured as follows:
Parameters
Parameter | Description |
| Process name (required) |
| Process version, used to find the correct process you want to use to create the request |
| This parameter will be null if the request creator did not define it in the request payload |
| ID of newly created request |
| Number of newly created request |
| This parameter contains the delegator ID; however, if the request was not created in delegation mode, its value will be null |
| This parameter contains the delegator username; however, if the request was not created in delegation mode, its value will be null |
OpenAPI v2 endpoints
As of version 7.17.0, incoming webhooks now offer a new endpoint that supports the OpenAPI v2 specification for operation definitions and another endpoint for operation execution. This allows for seamless integration with other OpenAPI-ready solutions such as Swagger, Microsoft Flow, Azure Logic Apps and Postman.
Webhook operation definitions
Use this endpoint to retrieve webhook operation definitions based on the OpenAPI v2 specification (in JSON format).
Webhook operation execution
Use this endpoint to execute a webhook operation using HTTP POST, replacing :operation
with the name of the incoming webhook operation (e.g. createRequest
).
Required parameters
:operation
: Name of the incoming webhook operation defined in the URI ✏️ Note: The operation name is not required inside the request payload.x-wfgen-hooktoken
: Webhook token value specified in the HTTP request header, which is the same token value as used in a classic incoming webhooks URL
Other required or optional parameters specific to the webhook operation might be needed.
Request operations
Create a new request
To create a new request from the webhooks API, make sure that sub-process mode is enabled with public access on the target process. (See the Process form section in the WorkflowGen Administration Guide for more information.)
Request payload:
Response payload:
A parameter's array can be included in the createRequest
operation payload. Be aware that a data with the same name and data type must previously exist in the process for each parameter in the array to store the parameter's value. The following example shows how to send parameters corresponding to the four supported data types (TEXT, NUMERIC, DATETIME, and FILE).
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Process name (required) |
| Int | Process version, used to find the correct process you want to use to create the request |
| String | Client mutation identifier |
| Boolean | Indicates if the process is in test |
| Base64-encoded string | User identifier that is used by the user to perform the mutation on behalf of another person, with the pattern |
| Base64-encoded string | Process identifier with the pattern |
| Array | Array of parameters (see Parameter definitions) |
Update a request dataset
A request dataset context can be updated by adding a parameter array. In this case a request number or a request ID should be provided.
This operation requires users to have system access to perform it. This can be configured in the System operations allowed users field under Security on the Integration tab in the Configuration Panel.
Request payloads:
Response payload:
For more information on FILE parameter manipulations when sent within incoming webhook payloads, see the File upload section.
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Int | Request number |
| Base64-encoded string | Request identifier with the pattern |
| Array | Array of parameters (see Parameter definitions) |
Cancel a request
You can cancel a request by using the request number or the request ID.
Request payloads:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Int | Request number |
| Base64-encoded string | Request identifier with the pattern |
| Boolean | Indicates if participant members have to be notified |
| Base64-encoded string | User identifier that is used by the user to perform the mutation on behalf of another person, with the pattern |
Delete a request
A request can be deleted by using the request number or the request ID.
Request payloads:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Base64-encoded string | Request identifier with the pattern |
| Int | Request number |
Action operations
Complete an action
To complete an action, provide the request number and the action number, or the action ID.
Request payloads:
Response payload:
To complete an action, a parameter array can be included in the request payload arguments.
Request payload:
Response payload:
Properties
Property | Type | Description |
| Int | Request number |
| Int | Action number |
| String | Activity name |
| String | Client mutation identifier |
| Boolean | Indicates if the process is in test |
| Base64-encoded string | User identifier that is used by the user to perform the mutation on behalf of another person, with the pattern |
| Base64-encoded string | Action identifier with the pattern |
| Array | Array of parameters (see Parameter definitions) |
Complete a form action
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Activity name |
| Base64-encoded string | Action identifier with the pattern |
| Int | Action number |
| Base64-encoded string | User identifier used by the user to perform the mutation on behalf of another person with the pattern |
| Array | Array of parameters (see Parameter definitions) |
| Int | Request number |
Cancel an action
To cancel an action, provide the request number and the action number, or the action ID. The following conditions must be met:
The viewer and the user (if they don't share the same identity, as in delegation mode) must have access to the request.
The action must be open.
The action must have a cancel or default exception defined in the transition.
The viewer is:
an administrator or process folder manager OR
a supervisor with cancellation rights OR
the action assignee.
Request payloads:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Exception:
|
| Base64-encoded string | Action identifier with the pattern |
| Int | Action number |
| Base64-encoded string | User identifier used by the user to perform the mutation on behalf of another person with the pattern |
| Int | Request number |
| Cancellation type:
|
Cancel a request's actions by name
All of the actions with the same name in a request can be cancelled at the same time by using their name in this operation payload. The following conditions are met:
The viewer and the user (if they do not share the same identity, as in delegation mode) must have access to the request.
The action must be open.
The action must have a cancel or default exception defined in the transition.
The viewer is:
an administrator or a process folder manager OR
a supervisor with cancellation rights OR
the action assignee.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Activity name |
| String | Client mutation identifier |
| String | Exception:
|
| Base64-encoded string | User identifier used by the user to perform the mutation on behalf of another person with the pattern |
| Int | Request number |
| Cancellation type:
|
Assign an action
To assign an action, provide the request number and the action number, or the action ID; you must also provide the assigneeUserName
or the assigneeId
.
Request payloads:
Response payload:
Properties
Property | Type | Description |
| Base64-encoded string | User identifier of the person assigned to the action with the pattern |
| String | Client mutation identifier |
| Base64-encoded string | Action identifier with the pattern |
| Int | Action number |
| Base64-encoded string | User identifier used by the user to perform the mutation on behalf of another person with the pattern |
| Int | Request number |
Cancel an action assignment
To cancel an action assignment, you should provide the request number and the action number, or the action ID.
Request payloads:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Base64-encoded string | Action identifier with the pattern |
| Int | Action number |
| Base64-encoded string | User identifier used by the user to perform the mutation on behalf of another person with the pattern |
| Int | Request number |
End-user operations
Create a new favorite
The incoming webhook application lets users add processes and views to their favorites lists using the process or view IDs.
Request payload:
The above code will create a favorite using the process or view description, but adding a custom description is also possible, as shown in the following example:
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Favorite description |
| Base64-encoded string | Favorite item identifier with the pattern |
Update a favorite
The incoming webhook application lets users update an existing favorite process or view by using its favorite ID.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Favorite description |
| Base64-encoded string | Favorite item identifier with the pattern |
Delete a favorite
The incoming webhook application lets users delete an existing favorite process or view from their favorites list by using its favorites ID.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Base64-encoded string | Favorite item identifier with the pattern |
Add a comment
The incoming webhook application lets users add comments to requests.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | New comment message |
| Base64-encoded string | Identifier of the object to which the comment with be added with the pattern |
Update a comment
Users can update comments if they are administrators, process manager of the process or process supervisor, or standard users who are members of the process participants, have write permissions, and are the comment author.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Base64-encoded string | Comment identifier with the pattern |
| String | Updated comment message |
Remove a comment
The incoming webhook application lets users remove comments from requests.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Base64-encoded string | Comment identifier with the pattern |
Category operations
Create a new category
Only administrators can create a category.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Category description |
| String | Category name |
Update a category
Only administrators can update a category.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Category description |
| String | Category identifier with the pattern |
| String | Category name |
Delete a category
Only administrators can delete a category.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Category identifier with the pattern |
Process folder operations
Create a new process folder
Only administrators can create a process folder.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Process folder description |
| String | Process folder name |
| Base64-encoded string | Process folder manager identifier with the pattern |
Update a process folder
Only administrators and the process folder manager can update a process folder.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| String | Process folder description |
| Base64-encoded string | Process folder identifier with the pattern |
| String | Process folder name |
| Base64-encoded string | Process folder manager identifier with the pattern |
Delete a process folder
Only administrators can delete a process folder.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Base64-encoded string | Process folder identifier with the pattern |
Process operations
Create a new process
This operation creates a process from the process properties. The process name, description, and folder identifier or name are required.
Request payloads:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Process access level:
| |
| String | Process categories |
| String | Process description |
| Base64-encoded string | Process folder identifier with the pattern |
| String | Process folder name |
| Base64-encoded string | Process identifier used in new version creation with the pattern |
| String | Process help information email |
| String | Process help information text |
| URI | Process help information URL |
| Boolean | Indicates if action's associated data is archived when a request is closed |
| Boolean | Indicates if form management is built-in |
| Boolean | Indicates if file content is stored in the database |
| Boolean | Indicates if sub-process mode is enabled |
| Int | Process lead time |
| Process lead time duration unit:
| |
| Boolean | Indicates if working days/hours are used to compute the lead time |
| Boolean | Indicates if the requester is notified upon request closure |
| String | Process name |
| Boolean | Indicates if the requester is notified upon request closure |
| Process state:
|
Create a new process from an XPDL
A process can be created from its XPDL definition.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Boolean | Specifies whether or not to import process participants as global participants (can only be used by users with an administrator profile) |
| Boolean | Specifies whether or not to import global participant associations |
| Boolean | Specifies whether or not to add the current user to process participants |
| Base64-encoded string | Process folder identifier with the pattern |
| String | Process folder name |
| Base64-encoded string | Process identifier used when creating a new version with the pattern |
| String | Process name |
| Boolean | Creates a new version if the process already exists |
| Process state:
| |
| Boolean | Specifies whether or not to import the process version number from the process definition |
| FileInput | Process definition in XPDL format |
Update a process
This operation updates process properties from the process identifier.
Request payload:
Response payload:
Properties
Property | Type | Description |
| String | Client mutation identifier |
| Process access level:
| |
| String | Process categories |
| String | Process description |
| Base64-encoded string | Process folder identifier with the pattern |
| String | Process folder name |
| String | Process help information email |
| String | Process help information text |
| URI | Process help information URL |
| Base64-encoded string | Process identifier with the pattern |
| Boolean | Indicates if action's associated data is archived when a request is closed |
| Boolean | Indicates if form management is built-in |
| Boolean | Indicates if file content is stored in the database |
| Boolean | Indicates if sub-process mode is enabled |
| Int | Process lead time |
| Process lead time duration unit:
| |
| Boolean | Indicates if working days/hours are used to compute the lead time |
| Boolean | Indicates if the requester is notified upon request closure |
| String | Process name |
| Boolean | Indicates if the requester is notified upon request closure |
| Process state:
|
Update a process from an XPDL
A process can be updated from its XPDL definition. The .xml
file is uploaded by using the multipart file upload feature as shown below.