Process start via API

This documentation serves as a comprehensive guide to initiating process execution programmatically using our robust API capabilities. By leveraging the API, users gain the flexibility to seamlessly trigger the start of a process and automate the workflow. In this documentation, we will explore the necessary steps, required parameters, and example code snippets to empower you to initiate the process start effortlessly and efficiently. Let's dive in and unlock the power of process automation through API integration.

API endpoint to starting business process via API: https://base.stackflows.com/docs/environment#business-process-models-POSTapi-v2-environment-business-process-models--business_process_model--start

Making a request

Here is a bash sample:

curl --request POST \
    "https://base.stackflows.com/api/v2/environment/business-process-models/0988b8a0-0514-11ee-90b9-0f5e36373b39/start" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"external_execution_reference\": \"placeat\",
    \"submission\": [
        \"sint\"
    ]
}"

Things to know:

• The authorisation token is an environment token which can be found in Organization Settings at Stackflows User Area

• Body can be empty if the process doesn't contain any mandatory data to provide

• External_execution_reference is an external reference (Optional)

• Submission is optional and it's an array to provide mandatory

Activity after the process started

After successfully initiating the process execution via API, users can expect to see activity on user or service tasks within the process flow. These tasks represent the specific actions and operations that need to be performed to progress the process further. By monitoring the activity on these tasks, users can gain insights into the progress and status of the process execution.