Merge pull request #247 from twitchdev/eventsub-cost-doc-243

Updated docs for --count and --cost EventSub trigger flags
twitchdev · Jul 11, 2023 · 4022d15 · 4022d15
2 parents d030dc3 + efaa285
commit 4022d15
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/cmd/events.go b/cmd/events.go
@@ -142,12 +142,12 @@ func init() {
 	triggerCmd.Flags().StringVarP(&fromUser, "from-user", "f", "", "User ID of the user sending the event, for example the user following another user.")
 	triggerCmd.Flags().StringVarP(&giftUser, "gift-user", "g", "", "Used only for \"gift\" events. Denotes the User ID of the gifting user.")
 	triggerCmd.Flags().BoolVarP(&isAnonymous, "anonymous", "a", false, "Denotes if the event is anonymous. Only applies to Gift and Sub events.")
-	triggerCmd.Flags().IntVarP(&count, "count", "c", 1, "Count of events to events. This will simulate a sub gift, or large number of cheers.")
+	triggerCmd.Flags().IntVarP(&count, "count", "c", 1, "Number of times to run an event. This can be used to simulate rapid events, such as multiple sub gift, or large number of cheers.")
 	triggerCmd.Flags().StringVarP(&eventStatus, "event-status", "S", "", "Status of the Event object (.event.status in JSON); currently applies to channel points redemptions.")
 	triggerCmd.Flags().StringVarP(&subscriptionStatus, "subscription-status", "r", "enabled", "Status of the Subscription object (.subscription.status in JSON). Defaults to \"enabled\".")
 	triggerCmd.Flags().StringVarP(&itemID, "item-id", "i", "", "Manually set the ID of the event payload item (for example the reward ID in redemption events). For stream events, this is the game ID.")
 	triggerCmd.Flags().StringVarP(&itemName, "item-name", "n", "", "Manually set the name of the event payload item (for example the reward ID in redemption events). For stream events, this is the game title.")
-	triggerCmd.Flags().Int64VarP(&cost, "cost", "C", 0, "Amount of bits or channel points redeemed/used in the event.")
+	triggerCmd.Flags().Int64VarP(&cost, "cost", "C", 0, "Amount of subscriptions, bits, or channel points redeemed/used in the event.")
 	triggerCmd.Flags().StringVarP(&description, "description", "d", "", "Title the stream should be updated with.")
 	triggerCmd.Flags().StringVarP(&gameID, "game-id", "G", "", "Sets the game/category ID for applicable events.")
 	triggerCmd.Flags().StringVarP(&tier, "tier", "", "", "Sets the subscription tier. Valid values are 1000, 2000, and 3000.")

diff --git a/docs/event.md b/docs/event.md
@@ -78,7 +78,7 @@ This command can take either the Event or Alias listed as an argument. It is pre
 | `--charity-current-value` |           | For charity events, manually set the charity dollar value.                                                                      | `--charity-current-value 11000`              | N               |
 | `--charity-target-value`  |           | For charity events, manually set the charity dollar value.                                                                      | `--charity-current-value 23400`              | N               |
 | `--client-id`             |           | Manually set the Client ID used for revoke, grant, and bits transactions.                                                       | `--client-id 4ofh8m0706jqpholgk00u3xvb4spct` | N               |
-| `--cost`                  | `-C`      | Amount of bits or channel points redeemed/used in the event.                                                                    | `-C 250`                                     | N               |
+| `--cost`                  | `-C`      | Amount of subscriptions, bits, or channel points redeemed/used in the event.                                                    | `-C 250`                                     | N               |
 | `--count`                 | `-c`      | Count of events to fire. This can be used to simulate an influx of events.                                                      | `-c 100`                                     | N               |
 | `--description`           | `-d`      | Title the stream should be updated/started with.                                                                                | `-d Awesome new title!`                      | N               |
 | `--event-status`          | `-S`      | Status of the Event object (.event.status in JSON); Currently applies to channel points redemptions.                            | `-S fulfilled`                               | N               |