Actions17
Overview
This node integrates with KoboToolbox, a platform for data collection via forms. Specifically, the "Form" resource's "Redeploy" operation triggers a redeployment of a specified form on KoboToolbox. Redeploying a form typically means applying any changes made to the form's design or settings so that they become active and available for data collection.
Common scenarios where this node is useful include:
- After updating a form's structure or questions, you want to activate those changes immediately.
- Automating workflows where form updates are part of a larger process, ensuring the latest version is always deployed.
- Managing multiple forms programmatically without manual intervention in the KoboToolbox UI.
Example: You have edited a survey form to add new questions. Using this node, you can redeploy the updated form automatically as part of your workflow, making it ready for respondents.
Properties
| Name | Meaning |
|---|---|
| Form Name or ID | The unique identifier or name of the form to redeploy. You can select from a list of available forms or specify an ID using an expression. |
Output
The output JSON contains the response from the KoboToolbox API after redeploying the form. This typically includes details about the form's deployment status and metadata confirming the redeployment action.
The node does not output binary data for this operation.
Dependencies
- Requires an API key credential for authenticating with the KoboToolbox API.
- The node uses the KoboToolbox REST API endpoint
/api/v2/assets/{formId}/deployment/with the PATCH method to trigger redeployment. - No additional external services are required beyond access to the KoboToolbox API.
Troubleshooting
- Common issue: Providing an invalid or non-existent form ID will cause the API request to fail.
- Resolution: Ensure the form ID is correct by selecting from the provided options or verifying the ID manually.
- Error message: If the redeployment fails, the node may throw an error indicating a failed API request.
- Resolution: Check network connectivity, API credentials validity, and whether the form is accessible and modifiable.
- Permission errors: Insufficient permissions on the API key may prevent redeployment.
- Resolution: Verify that the API key has appropriate rights to modify and deploy forms.
Links and References
- KoboToolbox API Documentation
- n8n Expressions Documentation (for specifying dynamic form IDs)