Flows
Create Flow
Get Started
Endpoints
- Projects
- Project Members
- Connections
- Flows
- Flow Runs
- Pieces
- Git Sync
Flows
Create Flow
Create a flow
POST
/
v1
/
flows
curl --request POST \
--url https://cloud.activepieces.com/api/v1/flows/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"folderName": "<string>",
"projectId": "<string>"
}'
{
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"folderId": "<string>",
"status": "ENABLED",
"schedule": {
"type": "CRON_EXPRESSION",
"cronExpression": "<string>",
"timezone": "<string>"
},
"publishedVersionId": "<string>",
"version": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"flowId": "<string>",
"displayName": "<string>",
"trigger": {
"name": "<string>",
"valid": true,
"displayName": "<string>",
"nextAction": "<any>",
"type": "PIECE_TRIGGER",
"settings": {
"pieceName": "<string>",
"pieceVersion": "<string>",
"pieceType": "CUSTOM",
"packageType": "ARCHIVE",
"triggerName": "<string>",
"input": {},
"inputUiInfo": {
"currentSelectedData": "<any>",
"customizedInputs": {},
"lastTestDate": "<string>"
}
}
},
"updatedBy": "<string>",
"valid": true,
"state": "LOCKED"
}
}
Authorizations
Use your api key generated from the admin console
Response
201 - application/json
Default Response
Available options:
ENABLED
Available options:
PIECE_TRIGGER
Available options:
CUSTOM
Available options:
ARCHIVE
Available options:
LOCKED
curl --request POST \
--url https://cloud.activepieces.com/api/v1/flows/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"folderName": "<string>",
"projectId": "<string>"
}'
{
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"projectId": "<string>",
"folderId": "<string>",
"status": "ENABLED",
"schedule": {
"type": "CRON_EXPRESSION",
"cronExpression": "<string>",
"timezone": "<string>"
},
"publishedVersionId": "<string>",
"version": {
"id": "<string>",
"created": "<string>",
"updated": "<string>",
"flowId": "<string>",
"displayName": "<string>",
"trigger": {
"name": "<string>",
"valid": true,
"displayName": "<string>",
"nextAction": "<any>",
"type": "PIECE_TRIGGER",
"settings": {
"pieceName": "<string>",
"pieceVersion": "<string>",
"pieceType": "CUSTOM",
"packageType": "ARCHIVE",
"triggerName": "<string>",
"input": {},
"inputUiInfo": {
"currentSelectedData": "<any>",
"customizedInputs": {},
"lastTestDate": "<string>"
}
}
},
"updatedBy": "<string>",
"valid": true,
"state": "LOCKED"
}
}