KoboToolbox 2 icon

KoboToolbox 2

Work with KoboToolbox forms and submissions

Actions17

Overview

This node interacts with KoboToolbox, a platform for data collection using forms. Specifically, the "Hook" resource with the "Get" operation retrieves details about a specific webhook (hook) associated with a given form. Webhooks in KoboToolbox are used to send real-time notifications or data to external services when certain events occur on a form.

Common scenarios where this node is beneficial include:

  • Monitoring webhook configurations for a particular form.
  • Debugging or auditing webhook setups by fetching their current state.
  • Integrating with other systems that require knowledge of existing webhooks before performing further actions.

For example, if you have a form collecting survey responses and want to verify the webhook URL or status configured for that form, this node can fetch that information directly.

Properties

Name Meaning
Form Name or ID The identifier of the form to which the webhook belongs. You can select from a list of forms or specify an ID via expression. Example: aSAvYreNzVEkrWg5Gdcvg.
Hook ID The unique identifier of the webhook to retrieve. It starts with "h", e.g., hVehywQ2oXPYGHJHKtqth4. This specifies which hook's details to fetch.

Output

The output is a JSON array containing the webhook object retrieved from KoboToolbox. This object includes all properties of the webhook such as its ID, URL, event triggers, status, and any other metadata provided by the KoboToolbox API.

No binary data is output by this operation.

Example output structure (simplified):

[
  {
    "id": "hVehywQ2oXPYGHJHKtqth4",
    "url": "https://example.com/webhook",
    "event": "submission.created",
    "active": true,
    "created_at": "2023-01-01T12:00:00Z",
    ...
  }
]

Dependencies

  • Requires an active connection to the KoboToolbox API via an API key credential configured in n8n.
  • The node uses the KoboToolbox REST API endpoint /api/v2/assets/{formId}/hooks/{hookId} to fetch the webhook details.
  • The user must have appropriate permissions to access the form and its hooks.

Troubleshooting

  • Error: No hook found matching the specified Hook ID
    Ensure the Hook ID is correct and corresponds to a webhook associated with the selected form. Verify the form ID and hook ID inputs.

  • Authentication errors
    Confirm that the API key credential is valid and has sufficient permissions.

  • Network or API errors
    Check network connectivity and KoboToolbox service status. Retry later if the service is temporarily unavailable.

  • Invalid Form ID
    If the form ID does not exist or is inaccessible, the request will fail. Use the "Form Name or ID" dropdown or expression carefully.

Links and References

Discussion