GitScrum / Docs

User Story Voted

Webhook payload reference for the user-stories.vote event, triggered when a user story receives a vote.

Triggered when a user votes on a user story.

  • Event: user-stories.vote
  • Category: User Stories
  • Triggers: Clicking the vote button on a user story

Payload

This event sends a compact custom payload — not the full user story resource:

{
  "user-story": {
    "uuid": "user-login-flow"
  },
  "total": 5,
  "voted": true
}

Field Reference

FieldTypeDescription
user-story.uuidstringThe user story slug (not a UUID)
totalintegerUpdated total vote count
votedbooleanWhether the current user has voted (true) or unvoted (false)

Notes

  • The uuid field contains the user story slug, not a standard UUID.
  • voted: false indicates the user removed their vote (unvoted).
  • Only the vote state is sent — use the slug to look up the full user story via the API.