Async requests

A lot of operations within our API are asynchronous. Below are some examples on what the flows are for different kind of request/calls to our API.

You need to be subscribed to the Webhooks to receive updates resources or fields.

Triggering a FlowRun

To trigger a FlowRun a post request to /flow-runs with the MessageThread and a Flow is required. Once created you will receive the created FlowRun with the status created. All further updates will be done via Webhooks.

Once created we will instantaneously try to start the FlowRun and send you an update of the changed status of the FlowRun to running once the status changes again to finished, timeout or exception you will get a new notification.

The state attribute will contain data gathered during the flow.

Visualized it looks like this:

Generating a "vacancy_application_flow"

Triggering a FlowGeneration follows a similar path, in this example we will visualize the creation of a vacancy_application_flow.

As input for the FlowGeneration, you can optionally use the VacancyAnalysis, after that POST to /flow-generations. All further updates will be done via Webhooks.