Vote Kit icon

Vote Kit

Consume Vote Kit API

Overview

This node integrates with the Vote Kit API to manage voting polls and options. It supports creating, updating, retrieving, listing, and deleting votes (polls) and their options. The node is useful for automating workflows involving polls, such as setting up new votes, modifying existing ones, managing vote options, or fetching poll results.

Practical examples include:

  • Creating a new poll with specific voting rules and options.
  • Updating an existing poll’s details or options.
  • Retrieving poll data to display results or analyze voter participation.
  • Deleting outdated polls or options.
  • Listing polls with pagination support.

Properties

Name Meaning
Title Title of the vote or option.
Description Description text explaining the vote (only for votes).
Max Vote Per User Maximum number of votes allowed per user in the poll.
Winner Count Number of winners to be selected in the poll.
Start Time Date and time when the poll starts.
End Time Deadline date and time when the poll ends.
Public Voter Info Whether voter information is publicly visible.
Public Option Create Whether users can publicly create options in the poll.
Public Comment Whether comments are allowed on the poll.
Allow Update Vote Whether voters are allowed to update their votes.
Hide Result Before End Whether to hide poll results until the poll ends.
Has Bonus Whether the poll includes a bonus reward system.
Share Bonus to Voters Whether to share bonus rewards with voters (requires Has Bonus enabled).
Bonus Percentage for Voters Percentage of bonus shared with voters if sharing is enabled.
Limit Options Per User Whether to limit the number of options a user can select.
Max Options Per User Maximum number of options a user can select if limiting is enabled.
Vote Options List of options available for voting (multiple values allowed).
Vote ID Identifier of the vote/poll (required for operations other than creating a vote).
Option ID Identifier of the option (required for updating or deleting an option).
Page Size Number of votes to list per page (for listing votes operation).
Page Count Page number to retrieve when listing votes.

Output

The node outputs JSON data representing the response from the Vote Kit API for the requested operation. This includes:

  • For Create Vote: Details of the newly created poll including its configuration and options.
  • For Get Vote: Full poll data including options, votes, and settings.
  • For List Votes: A paginated list of polls.
  • For Create/Update/Delete Option: Confirmation and details of the affected option.
  • For Delete Vote: Confirmation of deletion.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential to authenticate requests to the Vote Kit API.
  • Uses internal helper functions to make HTTP requests to the Vote Kit endpoints.
  • The node expects the environment to have access to the Vote Kit service endpoints.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing invalid or missing required parameters (e.g., Vote ID for update/delete) will result in errors.
    • Network connectivity issues may prevent successful API calls.
    • Attempting to update or delete non-existent votes or options will return errors.
  • Error messages:

    • Errors returned from the API are passed through; typical messages include "Poll not found", "Invalid parameters", or "Unauthorized".
    • To resolve, verify that all required parameters are correctly set, ensure valid API credentials, and confirm network connectivity.

Links and References

  • Vote Kit official documentation (not provided in source, please refer to your Vote Kit API docs)
  • n8n documentation on creating custom nodes and using API credentials

Discussion