Skip to content

Commit

Permalink
Merge pull request #305 from constantstress/patch-1
Browse files Browse the repository at this point in the history
Updated examples in event.md
  • Loading branch information
Xemdo authored Jan 4, 2024
2 parents 468b0e7 + ce41312 commit 413b8cf
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,11 @@ This command can take either the Event or Alias listed as an argument. It is pre
| `--to-user` | `-t` | Denotes the receiver's TUID of the event, usually the broadcaster. | `-t 44635596` | N |
| `--transport` | `-T` | The method used to send events. Can either be `webhook` or `websocket`. Default is `webhook`. | `-T webhook` | N |

**Examples**

```sh
twitch event trigger subscribe -F https://localhost:8080/ // triggers a randomly generated subscribe event and forwards to the localhost:8080 server
twitch event trigger cheer -f 1234 -t 4567 // generates JSON for a cheer event from user 1234 to user 4567
twitch event trigger subscribe -F https://localhost:8080/ # triggers a randomly generated subscribe event and forwards to the localhost:8080 server
twitch event trigger cheer -f 1234 -t 4567 # generates JSON for a cheer event from user 1234 to user 4567
```

## Retrigger
Expand Down Expand Up @@ -156,7 +157,7 @@ None
**Examples**

```sh
twitch event retrigger -i "713f3254-0178-9757-7439-d779400c0999" -F https://localhost:8080/ // triggers the previous cheer event to localhost:8080
twitch event retrigger -i "713f3254-0178-9757-7439-d779400c0999" -F https://localhost:8080/ # triggers the previous cheer event to localhost:8080
```

## Verify-Subscription
Expand All @@ -180,7 +181,7 @@ This command takes the same arguments as [Trigger](#trigger).
**Examples**

```sh
twitch event verify-subscription cheer -F https://localhost:8080/ // triggers a fake "cheer" EventSub subscription and validates if localhost responds properly
twitch event verify-subscription cheer -F https://localhost:8080/ # triggers a fake "cheer" EventSub subscription and validates if localhost responds properly
```

## WebSocket
Expand Down Expand Up @@ -220,4 +221,4 @@ twitch event websocket reconnect
twitch event websocket close --session=e411cc1e_a2613d4e --reason=4006
twitch event websocket subscription --status=user_removed --subscription=82a855-fae8-93bff0
twitch event websocket keepalive --session=e411cc1e_a2613d4e --enabled=false
```
```

0 comments on commit 413b8cf

Please sign in to comment.