Flow
Flow is a resource that represents a sequence of steps that a candidate must finish to complete a recruitment process such as an application or interview. Using FlowRun, a flow can be executed on a MessageThread, allowing the candidate to progress through the recruitment process. Flows can be created and managed via the Recrubo platform, but also generated with our AI engine via the API using the FlowGeneration resource.
Flows can be generated via a FlowGeneration but can also be manually created.
Endpoints
GET /flows- Retrieve a list of all flows.GET /flows/{id}- Retrieve a specific flow by ID.POST /flows- Create a new flow.PATCH /flows/{id}- Update a specific flow by ID.DELETE /flows/{id}- Delete a specific flow by ID.
Attributes
name
String
Name of the flow
reminderInterval
Integer
Reminder interval in minutes. If a candidate (after responding to the first message) does not reply within this interval a reminder message will be sent. Set to 0 to disable.
reminderMessage
String
The message that will be sent to the user when the reminderInterval expires.
sessionTimeout
Integer
The interval in minutes after which the FlowRun session will timeout if the candidate does not respond. After this timeout we will stop the FlowRun and the chat will be stopped.
publishedAt
DateTime
The date and time the flow was published. Flows created via a flow generation will automatically be published
unpublishedChanges
Boolean
Indicates if the flow has unpublished changes.
createdAt
DateTime
The date and time the flow was created.
updatedAt
DateTime
The date and time the flow was last updated.
HTTP Methods
name
X
X
X
reminderInterval
X
X
X
reminderMessage
X
X
X
sessionTimeout
X
X
X
flowGenerationId
X
publishedAt
X
unpublishedChanges
X
createdAt
X
updatedAt
X
Required Fields for Creation (POST)
name
String
Job Application Flow
reminderInterval
integer
15
reminderMessage
String
Don't forget to finish the chat, just a few questions left!
sessionTimeout
integer
360
Example POST body
Example PATCH body
OpenAPI
Last updated