Requirements Before you set up the credential, make sure you have an active KoBoToolbox account and an API access token from your account settings ready.[3]
Get your KoBoToolbox credentials Server select Required The server that hosts your account. Choose Global or European Union for the hosted servers, or Self-hosted to enter your own address.[1]
API Key password Required Your API token from the account page (or /token/). Sent as an Authorization Token header.[1]
Server URL url Only for a self-hosted server. The full address of your instance, for example https://kobo.example.org. With no trailing slash.[1]
Connect KoBoToolbox in WEXTL Log in to your WEXTL account, add the KoBoToolbox node module to your workflow, and click Create new credential . Optional: In the Credential name field, enter a name for the credential. Enter the authentication credentials you copied from your KoBoToolbox account, or follow the on-screen instructions to create the credential. If prompted, authenticate your account and confirm access. If you want to make changes to your credential in the future, follow the steps in Manage credentials → Notes Credentials are org-scoped. Share them with teammates from the Credentials picker on any of its nodes. For detailed information on connecting an application, see Connect an application →
KoBoToolbox triggers and actions on WEXTL The list below is a reference of every KoBoToolbox node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each KoBoToolbox node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch New Submissions Trigger Starts a workflow per new submission. Output fields[3] Field Type ID number UUID text Submission time date
Get a Hook Search Reads one hook from KoboToolbox. Input fields[3] Field Type ProjectRequired
choice HookRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Hook Log Search Shows one logged event of a hook. Input fields[3] Field Type ProjectRequired
choice HookRequired
choice UID LogRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Paired Data Connection Search Shows one data link of a project. Input fields[3] Field Type ProjectRequired
choice UID Paired DataRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Permission Assignment Search Details of a permission on a project. Input fields[3] Field Type ProjectRequired
choice UID Permission AssignmentRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Project Search Reads one project in full. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Project Deployment Search Shows how a project is deployed. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Project File Search Metadata of a single stored file. Input fields[3] Field Type ProjectRequired
choice UID FileRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Project Version Search Reads a version labelled by its deployment date. Input fields[3] Field Type ProjectRequired
choice VersionRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Submission Search Shows one submission with its answers. Input fields[3] Field Type ProjectRequired
choice IdRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Submission Attachment Search Reads one file attached to a submission. Input fields[3] Field Type ProjectRequired
choice UID DataRequired
text IdRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Submission Edit URL Search Link for editing a submission on the server. Input fields[3] Field Type ProjectRequired
choice IdRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a Submission Validation Status Search Shows how a submission was validated. Input fields[3] Field Type ProjectRequired
choice IdRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get a User Search Details for one user account. Input fields[3] Field Type UsernameRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Asset Snapshot Search Shows one snapshot and its details. Input fields[3] Field Type UID Asset SnapshotRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Asset Subscription Search Details of a subscription you hold. Input fields[3] Field Type UID Asset SubscriptionRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Attachment Audio Duration Search Reports how long audio attachments last. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Export Setting Search Reads a stored export setting. Input fields[3] Field Type ProjectRequired
choice UID Export SettingRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Export Task Search Fetches one export task and its details. Input fields[3] Field Type ProjectRequired
choice UID ExportRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Import Search Details of one import run. Input fields[3] Field Type UID ImportRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Organization Search Shows one organization with its details. Input fields[3] Field Type OrganizationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Organization Invite Search Stored details of an invite from an organization. Input fields[3] Field Type OrganizationRequired
choice GuidRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get an Organization Member Search Member details held on the server. Input fields[3] Field Type OrganizationRequired
choice UsernameRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Daily Submission Counts Search Day by day submission totals. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Export Setting Data Search Loads data for a saved export setting. Input fields[3] Field Type ProjectRequired
choice UID Export SettingRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get My Access Logs Search Access log entries tied to the connected user. Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get My Asset Usage Search Usage figures covering your account assets. Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Organization Asset Counts Search Totals of assets within an organization. Input fields[3] Field Type OrganizationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Organization Asset Usage Search Usage numbers reported for organization assets. Input fields[3] Field Type OrganizationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Organization Assets Search Asset records held under an organization on the server. Input fields[3] Field Type OrganizationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Organization Service Usage Search Service consumption figures of an organization. Input fields[3] Field Type OrganizationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Project Content Search Loads what a project contains. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Project File Content Search Fetches the data inside a stored file. Input fields[3] Field Type ProjectRequired
choice UID FileRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get Project Status Counts Search Number of projects per status. Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get the Current User Search Returns your KoboToolbox account details. Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Get the Server Environment Config Search Settings of the KoboToolbox server environment. Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Asset Snapshots Search Snapshots of assets stored on the server. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Asset Subscriptions Search Asset subscriptions held by your KoboToolbox account. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Available Permissions Search Permissions offered by the server. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Export Settings Search Export settings saved for a project. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Export Tasks Search Export tasks run for a project. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Hook Logs Search Log entries recorded for a hook. Input fields[3] Field Type ProjectRequired
choice HookRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Hooks Search Hooks configured on a project in KoboToolbox. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Imports Search Imports run on KoboToolbox. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Languages Search Languages the server knows. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List My Access Log Exports Search Access log exports requested by your KoboToolbox account. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Organization Invites Search Invites recorded for an organization in KoboToolbox. Input fields[3] Field Type OrganizationRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Organization Members Search Membership list of an organization on KoboToolbox. Input fields[3] Field Type OrganizationRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Organizations Search Organizations hosted on KoboToolbox. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Paired Data Connections Search Paired data links recorded in KoboToolbox. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Permission Assignments Search Permissions assigned on a project. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Project Files Search Stored files belonging to a KoboToolbox project. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Project History Actions Search History actions recorded in KoboToolbox for a project. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Project History Logs Search History log records stored for a project. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Project Versions Search Versions of a project as saved by KoboToolbox. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Projects Search Projects owned by your KoboToolbox account. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Submission Attachments Search Attachments recorded for a single submission in KoboToolbox. Input fields[3] Field Type ProjectRequired
choice UID DataRequired
text Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Submissions Search Submissions received in a project on KoboToolbox. Input fields[3] Field Type ProjectRequired
choice Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Tags Search Tags defined on KoboToolbox. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
List Users Search Users registered on KoboToolbox. Input fields[3] Field Type Limit number
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Add a Submission Action Records one new response on a form. Input fields[3] Field Type Form IDRequired
choice SubmissionRequired
object
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Assign a Permission Action Gives a user access on a project. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Assign Permissions (Bulk) Action Many permissions for one project in a single request. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Clone Permission Assignments Action Copies permission assignments in KoboToolbox. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create a Hook Action Pushes new responses to an outside URL. Input fields[3] Field Type ProjectRequired
choice NameRequired
text EndpointRequired
text Active boolean Email notification boolean Export type choice Auth level choice Payload template text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create a Paired Data Connection Action Links a project to paired data. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create a Project Action Makes a project on the KoboToolbox server. Input fields[3] Field Type NameRequired
text Asset typeRequired
choice Settings object Key text Value text Clone from text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create a Project File Action Stores a file inside a project. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create a Project History Export Action Writes the project history out as an export. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create an Asset Snapshot Action Builds an asset snapshot on the KoboToolbox server. Input fields[3] Field Type Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create an Asset Subscription Action Subscription to an asset for your KoboToolbox account. Input fields[3] Field Type Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create an Export Setting Action Stores export options for a project. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create an Export Task Action Starts an export run on a project. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create an Organization Invite Action Adds an organization invitation on KoboToolbox. Input fields[3] Field Type OrganizationRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Create My Access Log Export Action Asks the server to export your access log. Input fields[3] Field Type Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete a Hook Action Removes one hook from KoboToolbox. Input fields[3] Field Type ProjectRequired
choice HookRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete a Paired Data Connection Action Removes a paired data link. Input fields[3] Field Type ProjectRequired
choice UID Paired DataRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete a Project Action Project deletion on the KoboToolbox server. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete a Project File Action Stored file removal from a project. Input fields[3] Field Type ProjectRequired
choice UID FileRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete a Submission Action Deletes a submission from the KoboToolbox server. Input fields[3] Field Type ProjectRequired
choice IdRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete a Submission Validation Status Action Removes review status from a submission. Input fields[3] Field Type ProjectRequired
choice IdRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete an Asset Snapshot Action Snapshot removal on the server. Input fields[3] Field Type UID Asset SnapshotRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete an Asset Subscription Action Ends a subscription held by you. Input fields[3] Field Type UID Asset SubscriptionRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete an Attachment Action Removes one attachment from the server. Input fields[3] Field Type ProjectRequired
choice IdRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete an Export Setting Action Export setting removal from KoboToolbox. Input fields[3] Field Type ProjectRequired
choice UID Export SettingRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete an Export Task Action Export task deletion from KoboToolbox. Input fields[3] Field Type ProjectRequired
choice UID ExportRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete an Organization Invite Action Invite removal for an organization in KoboToolbox. Input fields[3] Field Type OrganizationRequired
choice GuidRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete Submission Validation Statuses (Bulk) Action Many submissions lose their validation status. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Delete Submissions (Bulk) Action Removes many submissions in one request. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Deploy a Project Action Puts a project into deployment. Input fields[3] Field Type ProjectRequired
choice ActiveRequired
boolean
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Duplicate a Submission Action Makes a copy of one submission. Input fields[3] Field Type ProjectRequired
choice IdRequired
text Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Import a Project File Action Loads an XLSForm into KoboToolbox. Input fields[3] Field Type Project choice XLSForm fileRequired
file Destination URL choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Make an API Call universal Direct KoBoToolbox REST API access for uncovered endpoints. Input fields[3] Field Type URLRequired
text MethodRequired
choice Headers array Header object Query String array Parameter object Body text
Output fields[3] Field Type Body text Headers object Status code number
Remove a Permission Assignment Action Revokes one permission on a project. Input fields[3] Field Type ProjectRequired
choice UID Permission AssignmentRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Remove an Organization Member Action Ends the membership of a user in an organization. Input fields[3] Field Type OrganizationRequired
choice UsernameRequired
text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Remove Permission Assignments (Bulk) Action Revokes many permissions at once. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Retry a Hook Action Runs a hook delivery again. Input fields[3] Field Type ProjectRequired
choice HookRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Retry a Hook Log Action Reruns one logged hook event. Input fields[3] Field Type ProjectRequired
choice HookRequired
choice UID LogRequired
text Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Run a Bulk Project Action Action One action applied to a group of projects. Input fields[3] Field Type Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Send a Bulk Attachment Delete Request Action Bulk call on the attachments of one project with no list. Input fields[3] Field Type ProjectRequired
choice
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update a Hook Action Edits a hook on the KoboToolbox server. Input fields[3] Field Type ProjectRequired
choice HookRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update a Paired Data Connection Action Adjusts a data link of a project. Input fields[3] Field Type ProjectRequired
choice UID Paired DataRequired
text Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update a Project Action Edits project details on the server. Input fields[3] Field Type ProjectRequired
choice Name text Settings object Key text Value text Description text
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update a Project Deployment Action Switches deployment of a KoboToolbox project. Input fields[3] Field Type ProjectRequired
choice ActiveRequired
boolean
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update a Submission Validation Status Action Records a review result for a submission. Input fields[3] Field Type ProjectRequired
choice IdRequired
text Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update an Export Setting Action Edits a saved export setting. Input fields[3] Field Type ProjectRequired
choice UID Export SettingRequired
text Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update an Organization Action Changes details held for an organization. Input fields[3] Field Type OrganizationRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update an Organization Invite Action Alters a sent invite. Input fields[3] Field Type OrganizationRequired
choice GuidRequired
text Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update an Organization Member Action Modifies a member stored on the server. Input fields[3] Field Type OrganizationRequired
choice UsernameRequired
text Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update Submission Validation Statuses (Bulk) Action Records review results for many submissions. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update Submissions (Bulk) Action Edits several submissions together. Input fields[3] Field Type ProjectRequired
choice Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Update the Current User Action Edits your own account profile. Input fields[3] Field Type Body fields array
Output fields[3] Field Type ID text Name text Status text Created at date Updated at date Data text
Other productivity integrations on WEXTL eSignatures.com[2] Send and manage electronic signature contracts and templates. Nextcloud Manage files, shares, users, and activity on your Nextcloud server. Beeminder Track goals, log datapoints, and manage pledges on Beeminder. Quickbase Query and upsert Quickbase records, manage tables and fields, and watch app events. ONLYOFFICE Docs Manage files, folders, sharing, and editing sessions on a self-hosted ONLYOFFICE Docs (Community Server) instance.