Start workflows from new KoboToolbox form submissions and read forms.
Explore 17 workflow actions for KoboToolbox, including account permissions and operation limits.
10 read actions7 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Create file
Write
Add a media or map file to a form from a URL (metadata.redirect_url) or from base64 content (with metadata.filename).
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Operation limits
KoboToolbox takes no idempotency key; form_media filenames must be unique per form, so a resent upload of the same file is refused.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete file
Write
Delete a file from a form.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete submission
Write
Delete one submission.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get file
Read
Read one file's details.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Get form
Read
Read one project by its UID.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Get hook
Read
Read one REST service with its success and failure counts.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Get submission
Read
Read one submission.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Get validation status
Read
Read a submission's validation status.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
List files
Read
Read one page of a form's media and map files.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Pagination: offset. Check the result for additional pages; a single action may not return every record.
List forms
Read
Read one page of the projects (survey assets) the user can see.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Pagination: offset. Check the result for additional pages; a single action may not return every record.
List hook logs
Read
Read a REST service's delivery logs, optionally by status (0 failed, 1 pending, 2 success).
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Pagination: offset. Check the result for additional pages; a single action may not return every record.
List hooks
Read
Read a form's REST services.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
List submissions
Read
Read one page of a form's submissions, optionally filtered with a Mongo-style query.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
Pagination: offset. Check the result for additional pages; a single action may not return every record.
Redeploy form
Write
Deploy a form version and make the deployment active; Get form shows the version_id.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
A repeated request may repeat the external action. Review the previous result before retrying a write.
Retry failed deliveries
Write
Retry every failed delivery of a REST service.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
A repeated request may repeat the external action. Review the previous result before retrying a write.
Retry one delivery
Write
Retry one failed delivery of a REST service.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update validation status
Write
Set a submission's validation status.
Permissions and limits
Account permissions
A KoboToolbox API key whose user can view the project
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in KoboToolbox. A saved workflow is not a completed provider action.