KoboToolbox 2 icon

KoboToolbox 2

Work with KoboToolbox forms and submissions

Actions17

Overview

The node integrates with KoboToolbox, a platform for data collection via forms and webhooks. Specifically, the Hook - Retry One operation allows users to retry sending a single webhook event that previously failed. This is useful in scenarios where a webhook delivery encountered temporary issues (e.g., network errors or remote server downtime) and you want to manually trigger a retry for a specific webhook log entry without resending all events.

Practical examples:

  • You have a form collecting survey responses and configured a webhook to notify your system.
  • One webhook delivery failed due to a transient error.
  • Using this node’s "Retry One" operation, you specify the form, the webhook, and the particular failed webhook log ID to retry just that event.

Properties

Name Meaning
Form Name or ID The unique identifier or name of the KoboToolbox form associated with the webhook. Choose from a list or provide an expression. Example: aSAvYreNzVEkrWg5Gdcvg.
Hook ID The unique identifier of the webhook within the specified form. It starts with "h". Example: hVehywQ2oXPYGHJHKtqth4.
Hook Log ID The unique identifier of the specific webhook log entry to retry. It starts with "hl". Example: hlSbGKaUKzTVNoWEVMYbLHe.

Output

The output JSON contains the response from the KoboToolbox API after attempting to retry the specified webhook log. Typically, this will include details about the retry attempt status or updated webhook log information.

The node does not output binary data for this operation.

Example output structure (simplified):

[
  {
    "id": "hlSbGKaUKzTVNoWEVMYbLHe",
    "status": "retrying",
    "timestamp": "2024-01-01T12:00:00Z",
    "message": "Retry initiated"
  }
]

Dependencies

  • Requires an active connection to the KoboToolbox API.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests.
  • The node uses internal helper functions to make authenticated HTTP PATCH requests to the KoboToolbox API endpoints.

Troubleshooting

  • Invalid Form or Hook IDs: If the provided form or hook ID does not exist or is mistyped, the API will return an error. Verify IDs by loading options or checking directly in KoboToolbox.
  • Invalid Hook Log ID: Providing a non-existent or incorrect hook log ID will cause the retry request to fail. Ensure the log ID corresponds to a valid webhook log entry.
  • Permission Issues: Insufficient API permissions or expired credentials can cause authorization errors. Refresh or update the API key as needed.
  • Network Errors: Temporary connectivity issues may prevent the retry request from succeeding. Retrying later or checking network settings can help.
  • API Rate Limits: Excessive retries or API calls might hit rate limits imposed by KoboToolbox. Monitor usage and space out requests if necessary.

Common error messages:

  • "404 Not Found": Resource (form, hook, or log) not found. Check IDs.
  • "401 Unauthorized": Authentication failure. Verify API credentials.
  • "400 Bad Request": Invalid parameters sent. Confirm property values.

Links and References

Discussion