`.
![A screenshot of the CSS code with the overlay settings highlighted]()
This might happen when you edit the **Body** in an external JSON editor and then copy it over to Next Matter. Data references need to be selected directly in Next Matter (by clicking the braces and selecting the value from the dropdown).
It might be because there are brackets or braces to the variable name. Make sure the name doesn't contain any brackets or braces.
If you're getting this error when clicking **Test integration** in the **Complete step automatically** template, it's because the auto-complete step relies on the instance ID of the running instance. Clicking **Test integration** in the editor with no running instance will always produce this error even if all placeholders are correct.
If this happens, try refreshing the screen.
Your integration test might fail with a Bad gateway or Not authorized error. In such cases, you can take over a step, re-configure it, and retry.
You can take over a step if you're a workflow owner or a workflow tech lead.
It might be because you've edited the value that's used in the condition, and you haven't updated the condition itself.
# Integrate with OneDrive
Source: https://help.nextmatter.com/docs/upload-to-onedrive
Upload files to Drive and create new folders straight from the Next Matter workflow.
## Before you begin
As part of the integration, you need to allowlist the Next Matter domain and create a service account. [See if you've completed all the required steps](/docs/integrate-with-microsoft).
* Get your OneDrive drive ID. You'll need it in the step configuration. To get the ID:
1. Sign in to [https://developer.microsoft.com/graph/graph-explorer](https://developer.microsoft.com/graph/graph-explorer).
2. Select GET as the method, and provide the following URL: `GET https://graph.microsoft.com/v1.0/users/{user-id}/drives`
```yaml Yaml theme={null}
GET /groups/{groupId}/drives //To fetch the drives within a group
GET /sites/{siteId}/drives //To fetch drives for a particular site
GET /me/drives //To list the current user's drive
```
For information on how to find site ID, see [Create a list in Sharepoint](create-a-list-in-sharepoint).
3. View the JSON response for the value of the **id** parameter.
* It might also happen that a placeholder can be replaced by a data reference of the data provided in one of the previous steps. That's why it's a good idea to learn more about [Data references](/docs/use-data-references).
## Upload a file to OneDrive
1. In your Next Matter workflow, click **+Add step** and select **Integration > Custom integration**.
2. Click **Settings** to configure the step.
3. Select Microsoft OneDrive in **Authorization**.
4. Enter the following details:
* **Method**: PUT
* **URL**: `https://graph.microsoft.com/v1.0/drives/DRIVE_ID/items/PARENT_ID:/FILE_NAME:/content`
The `PARENT_ID` is the name of the parent (folder) directory that the file will be inserted to.
* **Body type**: Binary
* In the **Body** enter the data reference to the file you want to upload.
5. Save your changes.
## Create a new folder in OneDrive
1. In your Next Matter, click **+Add step** and select **Integration > Custom integration**.
2. Click **Settings** to configure the step.
3. Select Microsoft OneDrive in **Authorization**.
4. Enter the following details:
* **Method**: PUT
* **URL**: `https://graph.microsoft.com/v1.0/drives/DRIVE_ID/items/PARENT_FOLDER_ID/children` You can find the info on how to find the DRIVE\_ID in the **Before you begin** section. The PARENT\_FOLDER\_ID is the name of the parent folder. It might also be `root`.
* **Headers**: Content-Type: application/json
* In the **Body** enter the name of the folder to create. For example:
```json JSON theme={null}
{
"name": "FOLDER_NAME",//replace the placeholder with the name of your folder
"folder": {}
}
```
5. Add a folder ID variable with the value of `$.id`.
6. Save your changes.
## Copy a file from one folder to the next
1. In your Next Matter workflow, click **+Add step** and select **Integration > Custom integration**.
2. Click **Settings** to configure the step.
3. Select Microsoft OneDrive in **Authorization**.
4. Enter the following details:
* **Method**: POST
* **URL**: `https://graph.microsoft.com/v1.0/me/drive/items/SOURCE_FOLDER_NAME/FILE_NAME:/copy`
* **Headers**: Content-Type: application/json
* In the **Body** enter the name of the folder to create. For example:
```json JSON theme={null}
{
"parentReference": {
"path": "drive/root:/DESTINATION_FOLDER_ID"/ you can find the ID by using Search File or Folder in Microsoft
},
"name": "NEW_FILE_NAME"//enter a new name for the copied file
}
```
5. Save your changes.
# Use cases: forms, actions
Source: https://help.nextmatter.com/docs/use-cases-actions
See how you can use workflows and workflow solutions to respond to specific business scenarios.
Design Workflows
Builder Toolbox
To validate if a date is in the future, use the [compare quick action](/docs/calculations#comparing-formulas) in Next Matter.
![Image of the compare formula quick action setup]()
To compare the dates, you need to format them into UNIX timestamps. To do that, select the cog wheel next to the date and enter %s in the **Custom format** field.
If you want to skip data references and enter a date yourself, use [this converter](https://www.epochconverter.com/) (external page) to create a UNIX timestamp that you'll enter into the **Formula** field in Next Matter. For example, comparing this date `01/07/2024` will look like this after the date has been converted:
![Image of the UNIX Timestamp Conversion in the Compare formula quick action setup]()
Assuming the instance start time is in November 2024, we're getting the correct `False` step result.
![The image of Future Date Validation step Result]()
Some customers must delete customer or other sensitive data after a set amount of time (for example 30 days). You can easily meet this compliance expectation by adding a non-blocking step at the workflow's start and having it start 30 days after the instance starting time.
This solution will automatically delete the instance together with all the media or files it might contain at the set time.
The instance will be deleted at the set time even if the instance hasn't been completed.
To build a reimbursement form, when users input several entries you can use either:
* A table
* Short text forms with conditions
**Use a table**
1. In your workflow, add **Form** as a step and add **Table** as a new form field.
2. Configure the table headers to display the information for the reimbursement. The data can either come from an external source or be a 2D array.
3. Select the option that enables users to add rows.
![]()
4. Add the **Image upload** form field if you want users to upload images.
Your table will look like the following and the users will be able to add rows and fill in the content.
![The image of the table form field configuration with the option to let users add rows selected]()
**Use conditional fields**
1. In your workflow, add **Form** as a new step and add several **Short text** fields. You can configure the fields to require reimbursement details.
![Image of several form fields]()
2. For the field where the sum is provided, make sure to add the **Allow only numbers** validation and allow decimals.
![Image of the short text field with the option to allow only numbers selected]()
3. Add the **Image upload** field so that users can upload their invoice pics.
4. Add the single choice dropdown field to ask users if they want to add more invoices.
![Image of the simngle choice dropdown form field]()
5. Duplicate the reimbursement form fields and create conditions on each of the fields to only show if the user selects to add more invoices.
![Image of the conditions pop-up]()
Normally the file upload form field allows you to upload a maximum of 50 files (and 50 MB per file). If you require to upload more, you can create multiple upload fields and show them based on conditions. Watch the video for details.
# Data references
Source: https://help.nextmatter.com/docs/use-data-references
If you want a step to be based on the data entered in the previous step, set a dynamic data reference. Then the data you need will be automatically extracted and inserted where you need it. The data can also be sent to databases or systems within your organization.
## About data references
Data reference is a dynamic placeholder in your workflow. When a step in the workflow is activated, the data reference will come from the information given in a previous step and be provided as a value.
For example, if someone enters their name in step one, step two might use a data reference in an email where the name that was provided in step one is used.
## Watch a video tutorial
## Add a reference to the form field
You can add references to form fields that are radio buttons, instructions, or drop-downs.
To do that:
1. On the form screen, click the settings icon.
![Image of the email step with the settingas icon highlighted]()
2. Click the braces icon.
![Image of the email form field with the braces to select data references highlighted]()
3. Select the reference you want to add from the dropdown. The dropdown is organized so that you can see which data can be extracted from which step.
4. Click **Save changes**.
When you use data references to transfer images or files(for example from one form to another), make sure you're using the **same form fields**. For example, if you uploaded an image with an image upload form field, and you want to populate a form with a data reference of this image, make sure you're populating an image upload form field, too. Trying to populate a file upload form field with an image data reference might cause errors on step completion. Likewise, using a file form field data reference to fill in an image form field won't work.
## Use data references in complex scenarios
You might use data references when you integrate with external tools and want to send data to the tool and extract the information back later, or [send data from one process to another](/docs/send-data-to-a-step-in-another-process).
You can also define your own data references based on response values (for example a sum of a calculation) available in an external tool.
## Referencing long text inputs
When referencing long text inputs in integration steps, use the JSON-formatted reference rather than the plain-formatted reference. This ensures that special characters such as linebreaks and quotes are encoded correctly.
## Find IDs to reference form fields or steps
1. In your left-hand navigation, click the **Workflows** icon.
2. Hover over the follow-up workflow and click on the menu icon.
3. Click **Edit workflow**.
4. Click the step to which you'd like to send data.
5. Copy the step ID. It's the last number in the URL you see in your browser.
![Image of the Next Matter URL with the step ID highlighted]()
You can get the ID by clicking the workflow and copying the number from the URL in your browser.
![Image of the Next Matter URL with the wotkflow ID highlighted]()
1. In your left-hand navigation, click the **Workflows** icon.
2. Hover over the follow-up workflow and click on the menu icon.
3. Click **Edit workflow**.
4. Click the step to which you'd like to send data.
5. Click the ID icon for the field to which you want to copy data.
6. Copy **Form field ID**.
![Image of the short text form field with the form field ID highlighted]()
# Create workflow tags
Source: https://help.nextmatter.com/docs/use-tags-for-better-filtering
You can create and tag instances and workflows to filter and find them easier.
## Why use tags in workflows
Tagging helps organize, categorize, or label content for easier findability, filtering, and analysis. You can use tags to achieve the following:
* Improved search and filtering: Tags make it easier to find relevant workflows quickly by associating items with specific keywords.
* Better organization: Tags help group-related workflows
* Context and clarity: Tags provide additional context, which can clarify workflow purpose
* Analytics: Tags can help track popular workflows
## Tags in Next Matter
You can define tags for a workflow and then select an appropriate tag for each instance. This might come in handy if you are running, for example, a hiring workflow and want to label the candidates as Rejected or Accepted.
In such a case, you can simply edit your instance and select the correct tag.
![Image of tags selector for the Next Matter instance]()
Note that you can add or edit tags if one of the following is true:
* auto-naming is disabled
* deadlines are enabled
* priority is enabled
## Create tags
1. Select a workflow to edit.
2. Add the tags in **Available tags**. Tags have a limit of 100 characters to maintain readability.
![Image of the tags selector with the option to add tags]()
Now you'll be able to select the right tag for each workflow instance.
You can filter your workflow instances by one or multiple tags. Go to the workflow **Overview**, click **Filters**. and expand the **Tags** dropdown to select the tags to search by.
The tag filter can be used to search through **active or completed instances** and is also available in your task list in the **Inbox**.
## Create tags with API
You can also create and add tags to instances when you [create instances with API](/reference/instances_create).
To add tags to an already active instance, use [this endpoint](/reference/instances_update).
# Use Twilio verification system
Source: https://help.nextmatter.com/docs/use-twilio-verification-system
Connect Next Matter and Twilio to use the One-Time-Password SMS Verification.
In this task, you'll need to complete the following tasks:
1. Activate Twilio Verify Service.
2. Configure the Next Matter integration (the main workflow and the sub-workflow).
## Before you begin
* Have your Twilio API key at hand. If you don't have it, [read how to generate it](/docs/integrate-with-twilio).
* Make sure you know where to find step ID, form field ID, and process ID in Next Matter.
1. In your left-hand navigation, click the **Workflows** icon.
2. Hover over the follow-up workflow and click on the menu icon.
3. Click **Edit workflow**.
4. Click the step to which you'd like to send data.
5. Copy the step ID. It's the last number in the URL you see in your browser.
![Image of the Next Matter URL with the step ID highlighted]()
1. In your left-hand navigation, click the **Workflows** icon.
2. Hover over the follow-up process and click on the menu icon.
3. Click **Edit workflow**.
4. Click the step to which you'd like to send data.
5. Click the ID icon for the field to which you want to copy data.
6. Copy **Form field ID**.
![An image of a step with the highlighted form fields ID]()
You can get the ID by clicking the follow-up workflow and copying the number from the URL in your browser.
![Image of the Next Matter URL with the workflow ID highlighted]()
* Make sure you know how to use data references. See [Data references](/docs/use-data-references).
**Good to know:** Check out our ready-made templates available when you add a step and select **Templates > 3rd party templates**. You can use the templates to create a set of pre-configured steps. Need a specific template? Click the **Contact us** button in the top right of the page and let us know.
## Activate Twilio Verify Service
1. Sign in to Twilio as an administrator.
2. Go to **Explore Products**.
3. In **All products**, scroll to the **Account security** section.
4. Click **Verify.**
5. Go to **Verify > Services**.
6. In the list of existing services, click the **+** icon. This will create a new service.
7. Give the service a name and copy the SID. You will need it in the Next Matter process.
## Configure the Next Matter integration
The OTP SMS Verification requires two workflows. One is the main process that you want to integrate with Twilio, and the other is a helper workflow that does the verification. The main process triggers the verification workflow.
The verification workflow can be used by more than one workflow. There is no need to create a separate verification workflow each time you create a new workflow.
To configure the integration, you'll need to do the following:
1. Create the verification workflow (if not previously created).
2. Set up the verification workflow.
3. Add the verification process trigger in the main workflow.
4. Set up the verification trigger steps.
### Create the verification sub-process
1. Open your workflow and add a new form step right with the data you want to collect. For example, click **+ Add Form field** and select **Short Text -Input** if you want to collect the user's surname.
2. To send the email to the user with the step to collect the data, you can create a custom integration step that will use Sendgrid integration. [See how to configure Sendgrid](/docs/integrate-with-sendgrid).
3. Configure the Sendgrid email step with the following data:
* **Method**: POST
* **URL**: `https://api.sendgrid.com/v3/mail/send`
* **Headers:** Content-Type: application/json
* **Headers:** Authorization: `Bearer SENDGRID_ENCODED_API_KEY`
* **Body** might look like the following:
```json JSON theme={null}
{
"from": {
"email": "service@[company-domain].com",
"name": "Next Matter Notifications"
},
"personalizations": [{
"to": [{
"email": "{81. Provide details - Customer email - Input (plain)} "
}],
"dynamic_template_data": {
"email-subject": "Your sandbox credentials are ready!",
"email-content": "Hi {81. Provide details - Customer name - Input (plain)},
Setup for your sandbox has been completed and your credentials are ready.
Please provide your input here
with this secure form
of where you want to get the following notifications and the SMS two-factor authentication."
}
}],
"template_id": "d-1aa0b4cd59214c18924a28c96ed78f7f"
}
```
4. Create a step that's an **instruction** assigned to the external user. The user will see these instructions when they click the public link that's provided in the email. Click **Settings** and enter the following in the Instruction field:
```
Click the Complete button, once you are ready to do the 2-Factor Authentification.
Go to this page immediately and
enter the code that you have received on your phone
(will only work once you Click Complete): {89. Verify yourself - Public URL}
```
5. Create a new step that's **Integration > Custom integration**. This step will send a request to Twilio to send a code to the user's phone. Enter the following in the step's **Settings**:
* **Method**: POST
* **URL**: `https://verify.twilio.com/v2/Services/TWILIO_VERIFY_SERVICE_SID/Verifications`
* **Headers:** Content-Type: application/x-www-form-urlencoded
* **Headers:** Authorization: `Basic TWILIO_ENCODED_API_KEY`
* **Body** might look like the following:
```
To=%2B{81. Provide details - Phone number. (Note: please include 1 before the area code.) - Input (plain)}&Channel=sms
```
* Select to skip this step on failure.
* Click **+ Add variable** and create an `error_message` variable with the value of `$.message` and a `status` variable with the value of `$.status`.
6. Save your changes.
7. Click **+ Add step** and select the step to be **Integration > Custom integration**. This step will automatically complete the verification process and send data to the main workflow. Enter the following in the step's **Settings**:
* **Method**: POST
* **URL**: `https://core.nextmatter.com/api/instances/{InstanceID}/complete_step/`
* **Headers:** Content-Type: application/json
* **Headers:** Authorization: `Api-Key NEXT_MATTER_API_KEY`
* **Body** might look like the following:
```json theme={null}
{
"step_id": "STEP_ID",
"actions": [
{
"action_id": "ACTION_ID1",
"input_object": {
"radioItemSelected": "{84. Send Text - Integration step - status (plain)}"
}
},
{
"action_id": "ACTION_ID2",
"input_object": {
"radioItemSelected": "{84. Send Text - Integration step - error_message (plain)}"
}
},
{
"action_id": "ACTION_ID3",
"input_object": {}
}
]
}
```
**Note:** Make sure to make the step non-blocking (**... > Make non-blocking**)
8. Save your changes.
9. Create a form step allowing internal users to verify if Twilio reported any error messages.
![Image of the form with a form field allowing internal users to verify if Twilio reported any error messages]()
**The next 4 steps below verify if the code entered by the user is correct.**
10. Create an integration step to inform the main process that the verification failed. Enter the following in the step's **Settings**:
* **Method**: POST
* **URL**: `https://core.nextmatter.com/api/instances/{2. Provide details - Output instance id - Input}/complete_step/`
* **Headers:** Content-Type: application/json
* **Headers:** Authorization: `API Key NEXT_MATTER_API_KEY`
* **Body** might look like the following:
```json theme={null}
{
"step_id": "{2. Provide details - Target outcome of check step - Input (plain)}",
"actions": [
{
"action_id": "{2. Provide details - Action ID of Radio Button - Input (plain)}",
"input_object": {
"radioItemSelected": "{5. Send Text - Integration step - error_message (plain)}"
}
}
]
}
```
11. Save your changes.
12. This step is conditional and is only triggered if the verification status is canceled. Click **Add condition**, and specify that the step should only be triggered if the previous step didn't contain the pending status. ![A popup allowing users to add a condition to a step]()
13. Save your condition.
14. Create another Sendgrid integration step **with a condition** for when the status is pending. In this case, you want another email to be sent out to the user to complete the verification. Use the setting details from step 3, however, consider changing the **Body** to the following:
```json theme={null}
{
"from": {
"email": "service@[company-domain].com",
"name": "Verify by Next Matter"
},
"personalizations": [{
"to": [{
"email": "{2. Provide details - Customer email - Input (plain)}"
}],
"dynamic_template_data": {
"email-subject": "2 Factor Verification",
"email-content": "Please provide your access token with this secure link. Never share your token with anyone."
}
}],
"template_id": "d-1aa0b4cd59214c18924a28c96ed78f7f"
}
```
15. Click **Add conditions** to create your condition for step 12.
16. Create a form step with a field for the user to enter the verification code. Assign this step to the external user.
![Image of the conditions pop-up]()
17. Create an integration step for Twilio to verify the provided code. Click the **Settings** gear icon to configure the step:
* **Method**: POST
* **URL**: `https://verify.twilio.com/v2/Services/TWILIO_VERIFY_SERVICE_SID/VerificationCheck`
* **Headers:** Content-Type: application/x-www-form-urlencoded
* **Headers:** Authorization: `Basic TWILIO_ENCODED_API_KEY`
* **Body** might look like the following:
```
To=%2B{2. Provide details - Phone number. (Note: please include 1 before the area code.) - Input (plain)}&Code={10. Verify yourself - Please enter the code that you have received on your device. Your code is valid for 10 minutes. This is automatically blocked after 5 failed attempts. Write NOTRECEIVED if you didn't receive the code. - Input (plain)}
```
* Select to skip this step on failure.
* Click **+ Add variable** and create an `error_message` variable with the value of `$.message` and an `isOTPvalid` variable with the value of `$.status`.
18. Save your changes.
19. Click **Add conditions**, and create a condition for step 15 to run when step 14 didn't contain the NOTRECEIVED input.
20. Create a form step with the field to show the verification result (and any errors Twilio might have sent). Add a condition to this step to run if the verification step (step 10 was successfully completed).
![Image of the form step with a fields asking to specify the verification result]()
21. Create a step with a routing form field to verify how to proceed in case of verification errors. The step can go back to the step to re-send the code, but in the case of a wrong number can be modified.
You can add the following description for the user:
OTP code entered was not valid. Please select how to proceed. Consider that 'Return to 2. Send OTP' option will send the same code again to allow another attempt. After 5 attempts, the system gets blocked.
The step should have the following options:
* Confirm and continue
* Return to the Provide details step
* Decline and stop workflow
22. Click **Add conditions** to create the conditions for the step to run in the case the verification was not successful (code was not received, got stuck on send, or was not approved)
![Image of multiple configured conditons]()
The next 2 steps are conditional steps informing the main workflow of a verification failure or success.
23. Create an integration step to inform the main workflow of verification failure. Click the **Settings** gear icon to configure the step:
* **Method**: POST
* **URL**: `https://core.nextmatter.com/api/instances/{2. Provide details - Output instance id - Input}/complete_step/`
* **Headers:** Content-Type: application/json
* **Headers:** Authorization: `API-Key NEXTMATTER_API_KEY`
* **Body** might look like the following:
```json theme={null}
{
"step_id": "{2. Provide details - Target outcome of check step - Input (plain)}",
"actions": [
{
"action_id": "{2. Provide details - Action ID of Radio Button - Input (plain)}",
"input_object": {
"radioItemSelected": "{11. Verify Code - Integration step - error_message (plain)}"
}
}
]
}
```
24. Click **Add conditions** to add the conditions to the step to run when verification was not successful: ![Image of the conditions pop-up showing conditions to run the step when verification was not successful]()
25. Click **...** in the left-hand process panel and select **Make non-blocking**.
26. Create an integration step to inform the main workflow of verification failure. Click the **Settings** gear icon to configure the step:
* **Method**: POST
* **URL**: `https://core.nextmatter.com/api/instances/{2. Provide details - Output instance id - Input}/complete_step/`
* **Headers:** Content-Type: application/json
* **Headers:** Authorization: `API-Key NEXTMATTER_API_KEY`
* **Body** might look like the following:
```json theme={null}
{
"step_id": "{2. Provide details - Target outcome of check step - Input (plain)}",
"actions": [
{
"action_id": "{2. Provide details - Action ID of Radio Button - Input (plain)}",
"input_object": {
"radioItemSelected": "Successful"
}
}
]
}
```
27. Click **Add conditions** to add the conditions to the step to run when the verification was successful.
![Image of the condition pop-up with the configuration to run when the verification was successful]()
28. Click **...** in the left-hand workflow panel and select **Make non-blocking**.
### Create the main workflow
1. Create an integration step to launch verification.
In this step, you'll be calling the Next Matter API to launch the subworkflow. Click the **Settings** gear icon to configure the step:
* **Method**: POST
* **URL**: `https://core.nextmatter.com/api/instances/`
* **Headers:** Content-Type: application/json
* **Headers:**: Authorization: `API-Key NEXTMATTER_API_KEY`
* **Body** might look like the following:
```json JSON theme={null}
{
"process": "https://core.nextmatter.com/api/processes/VERIFICATION_WORKFLOW_ID/",//this is the ID of the sub-workflow described above
"name": "{Instance name}-Verification"
}
```
2. Create the following variables:
| Name | Value |
| ------------- | --------------------------------------------- |
| id | \$.id |
| url | \$.url |
| step\_id | \$.process\_snapshot.steps\[0].id |
| name\_aid | \$.process\_snapshot.steps\[0].actions\[0].id |
| email\_aid | \$.process\_snapshot.steps\[0].actions\[1].id |
| phone\_aid | \$.process\_snapshot.steps\[0].actions\[2].id |
| instance\_aid | \$.process\_snapshot.steps\[0].actions\[3].id |
| step\_aid | \$.process\_snapshot.steps\[0].actions\[4].id |
| action\_aid | \$.process\_snapshot.steps\[0].actions\[5].id |
3. Save your changes.
4. Create a step to send the details to the verification sub-workflow. Again, you'll be calling Next Matter API. Click the Settings gear icon to configure the details:
* **Method**: POST
* **URL**: `https://core.nextmatter.com/api/instances/{2. Launch OTP SMS Verification - Launch workflow automatically - id (plain)}/complete_step/`
* **Headers:** Content-Type: application/json
* **Headers:**: Authorization: `API-Key NEXTMATTER_API_KEY`
* **Body** might look like the following: Note that the data in are data references.
```json JSON theme={null}
{"step_id":{2. Launch OTP SMS Verification - Launch process automatically - step_id (plain)}
,"actions":[
{
"action_id":{2. Launch OTP SMS Verification - Launch process automatically - name_aid (plain)},
"input_object":{
"inputValue":"{2. Launch OTP SMS Verification - Launch process automatically - name_aid (plain)}"}},
{
"action_id":{2. Launch OTP SMS Verification - Launch process automatically - email_aid (plain)},
"input_object":{
"inputValue":"{2. Launch OTP SMS Verification - Launch process automatically - email_aid (plain)}"}},
{
"action_id":{2. Launch OTP SMS Verification - Launch process automatically - phone_aid (plain)},
"input_object":{
"inputValue":"{2. Launch OTP SMS Verification - Launch process automatically - phone_aid (plain)}"
}},
{
"action_id":{2. Launch OTP SMS Verification - Launch process automatically - instance_aid (plain)},
"input_object":{
"inputValue":"{Instance ID}"
}},
{
"action_id":{2. Launch OTP SMS Verification - Launch process automatically - step_aid (plain)},
"input_object":{
"inputValue":"RESULT_STEP_ID"// this is a placeholder for the step ID of the next step
}},
{
"action_id":{2. Launch OTP SMS Verification - Launch process automatically - action_aid (plain)},
"input_object":{
"inputValue":"RESULT_ACTION_ID"// this is a placeholder for the action ID from the next step
}
}
]}
```
5. Save your changes.
6. Create a radio form field step with the following details as radio items:
* Successful
* Max send attempts reached
* Challenge expired
![Image of the radio form filed with 3 radio items configured]()
7. Create a routing step with the following condition to run when verification has reached the send attempts limit.
![Image of the condition for the step to run when step 4 of the workflow has a maximum send attempts reached]()
The step should have the option to confirm and continue or return to step 2.
8. Create a form step with the field to share data with the verified user. Make sure you create the condition for this step to run when user verification has been successful.
![Image of the condition for the step to run when user verification has been successful]()
# User selection
Source: https://help.nextmatter.com/docs/user-selection
Let users select teams or team members as part of a form.
Not sure how to configure a form? [Learn more...](/docs/about-actions-and-action-types)
This field creates a dropdown with the members of your workspace to select from. You have the option to restrict the selection to specific users or user groups to make the selection relevant. You can make the restriction when you configure the form field. You can also create follow-up fields based on the selected user. For example, some fields may show when a specific user or a team is selected. You can do this by creating conditions for the follow-up fields.
Note that user selection fields only work for logged-in users and they don't show on public forms or steps with external assignees.
![Image showing user selection configuration with the restricted option selected]()
## Add tooltip to field
You can add extra information to help users provide the right input. The information will show when users hover over the info icon next to the field name.
![Image showing form field tooltip configuration and how it shows to users]()
## Complete a form using API
You can update field data and complete a form using API. To see examples of the JSON body you need for each form field, see [Completing steps](/docs/complete-a-step#completing-steps-using-api).
# Stages board
Source: https://help.nextmatter.com/docs/view-progress-of-process-instances
To help you monitor the progress of instances, you can create a stage board, and view all instances against these stages. The most basic stages would be: Started, In progress, and Completed.
If you have the board configured, you can see it in the workflow overview. The data on the board is updated in real-time, and you don't have to move items between columns.
If you added stages to the workflow after some instances of the workflow have been started, these instances will show in the **No stage** column of the board. When these instances are completed, the **No stage** column will disappear.
Additionally, if there are steps that take place before your first stage begins, the new instances of a workflow will also appear in the **No stage** column and remain there until the first stage is reached.
![Image of the stages board in Next Matter]()
## Set up the board
On the stages board, stages are ordered by creation time (the order in which they are added to the workflow). Note that you can set stages on top-level steps, not on nested steps.
1. Click a workflow to open it.
2. Find the step you want to be the first stage in the workflow and click the step to open it.
3. Click **Add a stage**.
4. Enter the name of the stage.
5. Click **Add stage**.
A flag will be displayed next to the step to mark where the stage starts. The workflow will remain in this stage even after this step has been completed. It will move to the next stage when the next step with an added stage is reached.
Setting stages for workflows is important when you allow external users to track the progress of instances they've created. Stages offer insights into their requests and provide them with the data they need to stay informed. You can toggle on tracing instances when you create a public form in your workflow.
### How stages are displayed on Stages Board
Stages are displayed on the stages board in the order they are added to the workflow.
**Example**: If you add a stage to Step 3 in your workflow, that stage will appear on your **Stages Board** when an instance reaches Step 3. Later, if you edit the workflow, add a stage to Step 1, and run another instance, the stage for Step 1 will appear after the stage for Step 3. This happens because the stage for Step 1 was created after the stage for Step 3, even though it’s earlier in the workflow.
To ensure a logical order on the **Stages Board**, add stages only after your workflow is fully built, starting with the earliest stages first.
Notes:
* If stages are added after some instances have already started, those instances will be shown in the **No stage** column of the **Stages Board**.
* If the first instance step with a stage has a scheduled start, the step will be in the **No stage** column until the step is activated when its scheduled date arrives.
* Stages are identified by the name at the moment of creation, which means that renaming a stage (or fixing a typo) creates a new one.
* Stages can't be versioned.
## Update stages
### Adding a new stage
You can add a new stage to the workflow at any time. The new stage column will immediately appear on the **Stages Board** however, it will only be used **by the instances started after** the new stage was added.
### Changing the stage name
The change will temporarily create a new column. The column with the old name will be on the board it is empty.
### Moving a stage
When you move a step with a stage, the order of the columns on the board will automatically be updated. You might have to reload the board.
### Deleting a stage
The deleted stage will disappear from the board when it is empty. Until then it will be displayed to the very right of the board.
### Triggering a stage
An instance enters a stage when a step is activated that has that stage assigned to it. It keeps the stage even when the subsequently activated steps have no stage assigned.
# Webhook triggers
Source: https://help.nextmatter.com/docs/webhook-triggers
Start a workflow based on triggers from external apps.
Use a Webhook trigger to start a workflow when an event occurs on a different platform (such as a customer response on a customer support ticket or a change to the application status in your applicant tracking system). You can also analyze the webhook response payload and extract useful variables that you can use in further steps of the workflow.
![Image of workflow start options in the workflow overvieww with webhook selected]()
You can find the destination webhook URLs in the developer documentation of the third-party apps.
## Watch a tutorial
## Set up a webhook
1. Go to **Workflows**.
2. Click **Create new ...> Start a new workflow**.
3. Give the workflow a name and click **Create**.
4. Click the start section in the left-hand panel.
5. Select **Webhook trigger**.
6. Select to enable the webhook.
7. Copy the Next Matter URL from the webhook URL field.
8. Go to the third-party app and select the payload you want to send to Next Matter
9. In the third-party app, make a POST call to the copied Next Matter URL. This way we'll be able to receive the payload.
10. Go back to Next Matter and click **Test webhook and select variables**. This will fill in the response body with payload data, and populate the variables dropdown.
We recommend running the webhook test from time to time to make sure the payload is up to date. If the new payload doesn't return some of the variables that have been selected, these variables get highlighted and should be deleted so that they don't break the workflow.
11. Select the variables from the dropdown and click **+ Add** for every variable you want to use later in the workflow. You can also add your own variables in the **Active webhook variables** section. If you plan to re-use these variables in further steps, the variables will display in the workflow metadata section as **webhook variables**.
12. Click **Save**.
Now, when an event happens, it triggers an instance and automatically populates the workflow data as per the selected variables.
![Image of an instance started with a webhook with started via webhook visible]()
## Disable the webhook
If you don't need a webhook anymore, you can disable it by clearing the **Enable webhook** box.
Note that this action deletes all data related to the webhook. If any workflows still use the variables extracted from the webhook's payload, these variables will show as broken and might cause the workflow to fail.
## Use a webhook variable for a dynamic list
When you receive a list as a response to a trigger and want to create a dynamic dropdown from this list, first select the list and turn it into a variable. Then you can use the variable as the source for a dynamic dropdown. Make sure you use `[*]` in the variable value. For example, `$.mylist[*]`. This will ensure the list is parsed correctly.
[Learn more about dynamic dropdowns](/docs/single-and-multi-select-dropdowns#dynamic-dropdowns)
# Welcome
Source: https://help.nextmatter.com/docs/welcome-to-next-matter
Next Matter is a platform for automating workflows, from complex processes across multiple teams and tools to repetitive and mundane ones.
![Graphic of workflow automation]()
## Trending
## Discover Next Matter by role
* [Use inbox](/docs/get-started-user#get-started-work-with-tasks)
* [Finish tasks](/docs/get-started-user#complete-a-task%3A-watch-a-tour)
* [Add users](/docs/grow-your-team#add-users)
* [Set access](/docs/team-permissions#team-permissions)
* [Create request](/docs/portal-user)
* [Track status](/docs/my-requests#track-your-portal-requests)
* [Connect apps](/docs/integrate-across-tools)
* [Start building](/docs/get-stared-builder)
* [Complete forms](/docs/guest-user#complete-tasks)
* [View progress](/docs/guest-user#track-progress)
* [Export data](/docs/export-data/)
* [Track progress](/docs/work-with-process-overview#instance-overview-table)
## Popular tasks
# Custom branding
Source: https://help.nextmatter.com/docs/white-labelling
You can offer multiple Next Matter services as your own ensuring seamless user experience.
Custom branding (or white labelling) refers to the practice of rebranding a service by another company as its own. This entails adding branding, logo, and design elements to the product, creating the appearance of ownership.
With Next Matter the extent of branding depends on the plan you're on.
## Available for all plans
* Design your own step completion messages (shown when users complete a step they've been assigned to)
![Image of a completion message]()
* Add your branding to public forms and progress tracker. You present these to guest users who don't log in to Next Matter.
![Image of a public form with a logo highlighted that can be updated]()
* Add your branding to portals. Portals are light (portal) user hubs offering a curated set of ready-to-start workflows.
![Image of Portals in Next Matter with a logo, dashboard, and dashboard logo highlighted as the elements that can be updated]()
## Available for the Enterprise plan
You can remove the "Powered by Next Matter" so that it's never visible to external users (guests). The badge disappears from all public forms and progress trackers.
![Image of a public form with Powered by Next Matter highlighted as the element that can be updated]()
# Start instances
Source: https://help.nextmatter.com/docs/work-with-instances
When you've built your workflow with the editor, your team can run it as an instance. There can be multiple instances of the same workflow.
You can start instances manually or automatically, by, for example, triggering a workflow on completion of another workflow.
You can define how you start a workflow instance when you build your workflow.
![Image of the start workflow options section in the workflow overview with the recurring option highlighted]()
## Start instances manually
You can start an instance by clicking the play icon on the workflow.
![Image of the start workflow options section in the workflow overview with the manual option highlighted]()
You can start multiple instances at once.
![Image of multiple instances waiting to be strted]()
## Start recurring instances
You can automatically start instances in intervals and configure the recurrence. You set up the starting date and the recurrence, and you're good to go.
![Image of the start workflow options section in the workflow overview with the recurring option highlighted]()
Each recurring workflow is marked with an icon. If you hover over it, you can see when the next workflow instance is started
![Image of the workflow overview page with the recurring icon highlighted under the workflow name]()
## Start instances by email
Automatically start an instance when an email is sent or forwarded to a dedicated workflow email address. To activate the email address for your workflow, contact our Support team.
## Start instances with API
You can start an instance by making a call to the `Create` endpoint. For details, see [API reference](/reference/instances_create).
**Tip:** Make sure you have your **API-Key** at hand to authenticate your request.
## Start instances from an imported file
Start multiple instances with a CSV, XLS, or XLSX file import. To import a file, contact our Support team. Note that import batches are billed per instance.
As part of the workflow, we map the values from the CSV to Next Matter instance values such as tags or instance name, add headers to the file, and launch the instance.
## Start instances with an external link
Allow anyone with a dedicated workflow portal link to start an instance of a workflow. No Next Matter account is required.
Learn how to do it
1. Click your workflow to open the overview.
2. Select **External Portal**.
3. Select **Create portal from first step**.
![Image of the start workflow options section in the workflow overview with the public form option highlighted]()
4. Copy the link and send it to the person who should start the workflow. Alternatively, you can generate a QR code to share.
The person who receives the link opens it in a browser when they are asked to complete the first step of the workflow. When they click complete, the workflow is set in motion.
![Image of a public form as users see it]()
## Start instances with a webhook
Set up the workflow instance to start only when an event happens (for example someone creates a Zendesk ticket).
[Learn more](/docs/webhook-triggers)
## Start instances of a process with another workflow
You can configure one workflow to start another workflow on completion of the first one. For details, see [Start a follow-up workflow](/docs/start-a-follow-up-process).
# Instance overview table
Source: https://help.nextmatter.com/docs/work-with-process-overview
In Next Matter, you have an overview of all workflows and a details overview per workflow.
You can get a visual representation of your entire workflow by clicking **Show Visual** in the top bar of the **Workflow overview**. For details, see [Visual editor](/docs/flowchart-view).
## Instance overview
This overview is available when you click **Workflows > Overview**. It helps you manage and track running instances and stop or delete an instance if needed. You can also use the **Filters** and sorting to find the instance you need. You can apply filtering to every column.
![Image of filters in the workfow overview]()
You can see the same view per workflow if you click it in the table.
## Customize overview
As an admin, you can also modify the table's look for your organization. You can change the order of columns, modify their width, and select which columns are visible (up to 20 columns per table). You can also display the content of form fields as column data. This is particularly helpful when you need to track specific information as part of your workflows. When you have modified the default view, simply publish the changes for everyone.
You can pull out data from the following form fields: short text, radio, checklist, date, single-value dropdown, and multi-value dropdown. You can only add custom data present in **the most recent** version of a workflow.
### Removed fields in custom columns
Next Matter displays custom data but also manages obsolete fields removed from the latest workflow versions.
If a field was removed from the workflow but has been added to the table, we display it in the selection pop-up. From the moment the field has been removed from the workflow, no new data has been populated in the table column, and if needed, you can remove the column from the table.
If you remove such a column from the table, you can't re-add it later on.
![Image of instance table congiguration showing active and removed columns]()
### Restricted fields
Next Matter also handles restricted data to ensure sensitive information isn't exposed to users without proper access rights.
## Workflow details overview
To see workflow details, click the workflow name on the list and click the pen icon or the eye icon on the left of the workflow name.
This opens general workflow details such as the list of steps, the details of the workflow lead, workflow visibility, status, and the tech lead.
![Image showing workflow details such as workflow owner]()
In the overview, you can also add useful notes on the workflow and upload anything relevant to the workflow.
## Workflow change history
You can see what changes have been made to the workflow, who made them, and when in the **Changelog** tab in the **Workflow overview**. The changelog displays all events from the latest to the oldest.
* For workflow managers: The changelog can help you with compliance and audit-readiness.
* For workflow builders: The changelog can help you update complex workflows, and test and release them. It can also be useful when you need to roll back specific updates.
![Image showing the changelog tab]()
## Resources
To help users complete and understand workflows, you can upload files (such as PDFs, PNGs, GIFs, or DOCs) or add useful links as workflow resources.
You can add resources on the **Workflow overview** page under the **Resources tab** or directly on the workflow page (accessible by clicking a workflow) in the top-right corner.
![Image showing the resources section for a specific workflow]()
When added, the resource will show on the workflow page and will be accessible to anyone who can view the workflow.
![Image showing the section with resources uploaded]()
To add the resource, you need to have the edit rights to the workflow. For details on permissions, see [Build teams (Permissions per user and team role)](/docs/build-teams).
A resource file can be a maximum of 50 MB.
# Templates
Source: https://help.nextmatter.com/docs/work-with-templates
Templates give you a head-start on integration. They create all the necessary steps and fill in the API details you need.
Templates are ready-made integration steps that display in your workflow.
To use a template, in your process click **+ Add step > Templates**. You can select out of the following template options:
* **3rd party templates**: these templates provide you with ready-made steps that use 3-rd party system integrations. Use them to quickly create workflows that send messages to Slack, write things to templates in Google Drive, and so on.
* **Next Matter templates**: these templates provide you with chunks of Next Matter ready-made workflows. Use these templates to quickly create steps for stopping an instance, automatically completing a step, and so on. Several templates provide you with steps that show you an example of a function in use. You can use these when you need to calculate or format a date or put together a URL.
![A screenshot of the list of step templates]()
Pick a template you want to use.
When you have the template in your workflow, click **Settings** for every step it created and configure it. In most cases, you'll need to enter the details in the placeholders in the **Body** of the step.
It might also happen that a placeholder can be replaced by a data reference of the data provided in one of the previous steps. To learn more about data references, see [Data references](/docs/use-data-references).
No idea what your workflow should look like? Our AI can help you build it!
1. Log in to Next Matter and click **Roadmap**.
2. Click **+ Create new process with AI**.
3. Describe your workflow and click **Generate workflow**. Don't worry about the **Steps count** for now.
4. If you like the workflow, click **Open in editor**, and tweak the details.
If you can't see the AI template builder in your editor, contact our Support team.
# Workflow lead and tech lead
Source: https://help.nextmatter.com/docs/workflow-lead-and-tech-lead
Ensure your workflow escalation contact person and the main stakeholder are set.
## Workflow lead
The workflow lead is the person who can view, change, or delete a workflow. They are the main contact people for the workflow. They are also the main business stakeholder. You can change the lead at any time.
## Tech lead
The tech lead might be the workflow builder or manage the technical aspects of the workflow. When a step fails, it automatically gets assigned to the tech lead. They also get notified if a step fails (in the **Needs attention** section of the Inbox and by email), and they can retry the step by test-tweaking the configuration.
The workflow lead remains the escalation contact if the tech lead is not set.
You can select the lead from among the workspace colleagues.
A tech lead is just a role that can be assigned to anyone, and it doesn't change the account's permissions. However, tech leads will be able to see the request body if the integration fails, even if the step visibility is restricted. Note that tech leads can't edit workflows, so they need to contact the admin to permanently update the configuration.
## Editor
The **editors** are users who can modify the workflow. They can add steps, change step assignees, add form fields, assign a technical lead, or change the workflow lead. Additionally, editors can duplicate or delete the workflow.
Each workflow can have multiple editors, but only one editor can make changes at a time. If another editor attempts to edit a workflow that is currently being edited, they will be notified, and the workflow will remain read-only for them until the active editor closes the workflow or switches tabs.
# Workflow versions
Source: https://help.nextmatter.com/docs/workflow-versions
Create draft workflows and roll back to a previous version, if needed.
## Use versions
Versioning allows you to make changes to workflows without them being immediately published. You can test the draft versions, while the current version in use remains unchanged. Version control is also key to staying compliant and audit-ready because you have lasting and granular insights into how your workflows changed, and when and who introduced the updates.
To use versions, simply edit a workflow. The breakdown of changes will be listed in the **Changelog** tab of **Workflow overview**. To find a list of versions, open the **Version control** tab.
When a new version is published, all instances that start after the publication use the latest version.
### How do I publish a version?
You can publish a version in the top bar of the workflow or from the **Version control** tab.
![Top navigation bar with the highlighted publish button]()
If you publish a version, all instances started after the version was published will be using this version. All instances started before, will be using the previous one.
### Can I edit a published version?
**Edit the current version**
You can always edit a version. If it's the current version, start editing the workflow. Your changes to the workflow will become a draft of the next version, and the version the instances will be starting with will still be the current version (without the new changes).
When you're happy with the changes, publish them and all the new instances will start with this published version.
**Edit a past version**
You can only edit a past version if you roll back to this version. Then the past version becomes the most current unpublished version, which you can edit as a draft.
### Can I delete a version?
You can only delete the draft version. You can't delete any published version because there might be instances that are linked to that version. Note that you can't delete the first version of the workflow because there is no version to roll back to. In this case, you need to delete the entire workflow (Click on the **workflow name > ...> Delete workflow**)
![Screenshot of the version control tab]()
### Can I delete my edits to a version?
Yes! Click the publish icon and click Discard all changes in the pop-up. That will delete all edits you made in a version.
### What happens when I roll back to an old version?
Let's say you have 5 versions of a workflow, and version 5 is the one you currently use. When you roll back to version 3 this version becomes your current version called version 6.
If, in the meantime, you started editing your workflow and created a new draft (so unpublished version 6), this version will be lost when you roll back.
Rolling back doesn't interrupt running instances. The ones started before the roll-back will be using the old version and those that start after the rollback will switch to the new one.
### What happens to version control when I duplicate a workflow?
When you duplicate a workflow, the version control entries **do not** get copied over. If you then delete the old workflow, you'll also delete its version control.
### What permissions do I have to use version control?
To edit the workflow, you need to be an admin or a workflow lead.
## Versions and Changelog
A version shows you the state of your workflow between the previous version and the next one. As such, it contains multiple changes introduced between versions. For example, it might be that three or more changes to a workflow have been introduced in a single version.
A changelog is a granular list of all changes introduced. For example, if you changed a step's name three times then each change will create a line in the changelog.
To learn more about the changelog, see [Change history](/docs/work-with-process-overview#workflow-change-history).
# About workflows and instances
Source: https://help.nextmatter.com/docs/workflows-and-instances
Normally, you start automating operations by building a workflow. When you have a workflow, you can then run its real-life instance.
The workflow is a generic blueprint of the operation flow, for example, Supplier onboarding. When you have your workflow lined out, you can use the workflow in real life. This means starting an instance of the workflow. The instance is the applied version of the workflow, for example, *Onboarding of supplier X*.
Each workflow has steps, forms, and assignees.
* **Steps**: workflows consist of multiple steps that are completed in order. Each step defines a clear activity that needs to be executed by a team or individual in your organization. For details, see [Steps](/docs/about-steps-and-step-types)
* **Forms**: while steps define the overarching structure of your workflow and its owners, form fields are detailed input fields required to complete the step, such as work instructions, data inputs like customer IDs, and many more. For details, see [About forms and form types](/docs/about-actions-and-action-types)
* **Assignees**: these are the people responsible for completing the steps they've been assigned to. For details, see [Find steps assigned to you](/docs/find-steps-assigned-to-you)
# Upload file
Source: https://help.nextmatter.com/reference/file/upload-file
/reference/openapi.json post /files/
Create a new file for the organization and (optionally) a specific workflow or instance.
Use the URI from the response to reference the file in your workflow.
Note that base64 is not natively supported as a direct upload format.
If you have a base64 file, convert it to binary before uploading.
It accepts a `file` field in the request data, with a file.
# Details of form field
Source: https://help.nextmatter.com/reference/form-field/details-of-form-field
/reference/openapi.json get /processes/{process_id}/steps/{step_id}/actions/{action_id}/
Show details of a form field including all instances the field is used in.
Page size is 100 by default, 500 maximum. To paginate, follow the standard usage of limit and page parameters.
We strongly recommend using filters with this endpoint and limiting the number of results, especially when requests are frequent. Otherwise, performance might degrade.
# Get started
Source: https://help.nextmatter.com/reference/getting-started
Get started with Next Matter public API.
## Create API key
Authentication is API-key based.
You need to be a Next Matter administrator to create an API key.
To generate the key:
1. Log in to Next Matter.
2. Go to **Company > Next Matter API keys**.
3. Click **+ Create API key**.
Authenticate by passing the API key in the "Authorization"
HTTP header proceeded with the string "Api-Key ".
For example:
Authorization: `Api-Key xyzabc.12fsfe242ubdgakew`
Read more on [managing API keys](/docs/api-keys)
## Postman collection
Import our [Swagger/OpenAPI specs](https://core.nextmatter.com/api/docs/?format=openapi) directly into Postman.
## Rate limit
Our rate limit is currently 100 requests per minute.
# Upload image
Source: https://help.nextmatter.com/reference/image/upload-image
/reference/openapi.json post /images/
Create and return a new image for the organization and specified workflow or instance.
It accepts an `image` field in the request data, with an image file.
# Complete step
Source: https://help.nextmatter.com/reference/instance/complete-step
/reference/openapi.json post /instances/{id}/complete_step/
Complete a step in an instance of a workflow. The step needs to be active and the user
that the API-Key is associated with needs to have access to the step (they need to act as assigned step owner, workflow lead, or an administrator).
# Create instance
Source: https://help.nextmatter.com/reference/instance/create-instance
/reference/openapi.json post /instances/
Create and return a new instance of the workflow
# Delete instances
Source: https://help.nextmatter.com/reference/instance/delete-instances
/reference/openapi.json post /instances/bulk/delete
Delete instances passed in the payload
# Get instance
Source: https://help.nextmatter.com/reference/instance/get-instance
/reference/openapi.json get /instances/{id}/
Get the details of an instance
# List workflow instances
Source: https://help.nextmatter.com/reference/instance/list-workflow-instances
/reference/openapi.json get /processes/{process_id}/instances/
List the instances of a given workflow, optionally filtered.
Filtering can be applied using the following query parameters:
- `name`: All instances with the name containing this substring
- `ordering`: Sorting by ascending or descending options: status, priority, ended_time, total_runtime, started_time. Use `-` to sort in a descending manner, for example: `-status`
- `status`: Use one of the options: `running`, `completed`, `aborted`
- `progress`: With suffix `_min` or `_max`
- `active_step_id`: Returns all instances of a workflow for which the step with the specified ID hasn't been completed and is currently active
- `priority`: Use one of the options: `V` (Very High) or `H` (High)
- `started_time`: With suffix `_after` or `_before`
- `last_updated_time`: With suffix `_after` or `_before`
- `deadline`: With suffix `_after` or `_before`
- `step_deadline`: With suffix `_after` or `_before`
- `aborted_time`: With suffix `_after` or `_before`
- `completed_time`: With suffix `_after` or `_before`
- `ended_time`: With suffix `_after` or `_before`
- `total_runtime_min`: Instance duration as `%d %H:%M:%S.%f` or ISO format
- `total_runtime_max`: Instance duration as `%d %H:%M:%S.%f` or ISO format
- `tags`: Name of the tag or tags separated by comma. Multiple tags are searched as OR condition.
- `page`: For pagination.
Dates follow the ISO8601 format and UTC standard.
Page size is 100 by default, 500 maximum. To paginate, follow the standard usage of `limit` and `page` parameters.
# Partially update instance
Source: https://help.nextmatter.com/reference/instance/partially-update-instance
/reference/openapi.json patch /instances/{id}/
Update selected instance properties
# Stop instances
Source: https://help.nextmatter.com/reference/instance/stop-instances
/reference/openapi.json post /instances/bulk/abort
Stop instances passed in the payload
# Update instance
Source: https://help.nextmatter.com/reference/instance/update-instance
/reference/openapi.json put /instances/{id}/
Update all instance properties
# Get workflow
Source: https://help.nextmatter.com/reference/workflow/get-workflow
/reference/openapi.json get /processes/{id}/
Get the details of a workflow
# List workflows
Source: https://help.nextmatter.com/reference/workflow/list-workflows
/reference/openapi.json get /processes/
Show all workflows that are visible to the user that the API-Key is associated with.