Launching flows

After you've created a flow, how you launch it depends on the launch type you assigned to it when creating it.

Launching a flow through the Inkit web app

To launch a flow that you created with a launch type of Fillable Form, do the following:

  1. In the Inkit web app, select Flows in the left sidebar, then click on the ... menu button beside the flow you want to invoke and click Invoke.

  2. In the Launch Flow page, enter Your Data for each Variable in the flow's templates.

    Then click Launch Flow.

Launching a flow through the Inkit API

To launching a flow that you created with a launch type of API, call the Launch Flow endpoint, specifying the following:

  • The ID of the flow
  • The execution name of the flow, which you can use to track it
  • The merge parameters for the flow

For example:

curl --request POST \
     --url https://api.inkit.com/v1/invoke \
     --header 'Content-Type: application/json' \
     --header 'X-Inkit-API-Token: ENTER YOUR API KEY' \
     --header 'accept: application/json' \
     --data '
{
  "flow_id": "ENTER YOUR FLOW ID",
  "name":"test",
  "merge_parameters": {
    "Name": "John"
  }
}
'