Testing webhook events

The event command lets you trigger mock events to test your webhook event handler locally. To use this command, you must have implemented an EventSub webhook event handler to process the event messages. For details, see Handling event notifications.

Triggering webhook events

Use the trigger sub-command to send mock events. The command’s argument identifies the event to trigger. For example, the following command triggers a Subscribe event.

twitch event trigger subscribe -F https://localhost:8080/eventsub/ 

List of events you can trigger

The following is the list of events that you can trigger. Specify these events as arguments of the trigger sub-command.

Flags to use when triggering events

Use these flags to describe the event’s behavior or to specify its data.

Examples

The following examples show how to use the flags.

// Triggers a Subscribe event and forwards it to the localhost:8080 server.

twitch event trigger subscribe -F https://localhost:8080/eventsub/ 

// Triggers a cheer event from user 1234 to user 4567.

twitch event trigger cheer -f 1234 -t 4567 -F https://localhost:8080/eventsub/

Retrigger an event

The retrigger sub-command lets you resend previous events using the event’s ID. For example, if the previous event was:

{
  "subscription": {
    "id": "713f3254-0178-9757-7439-d779400c0999",
    "type": "channels.cheer",
    ...
  }
}

You’d retrigger the event using:

twitch event retrigger -i "713f3254-0178-9757-7439-d779400c0999" -F https://localhost:8080/eventsub/ 

Flags to use when retriggering events

Use these flags to identify the event and describe the event’s behavior.

Verifying your event handler’s challenge response

The verify-subscription sub-command lets you test your event handler’s challenge response. When you subscribe to an event, Twitch verifies that you own the event handler specified in the request by sending your handler a webhook_callback_verification notification event. For more information, see Responding to a challenge request.

The following example verifies whether your event handler responds correctly to a challenge event.

twitch event verify-subscription cheer -F https://localhost:8080/eventsub/ 

The command’s output indicates whether response and status code are valid. The following shows a valid response.

✔ Valid response. Received challenge 5e784545-5a59-a05a-6ae6-cfaf260532f1 in body
✔ Valid status code. Received status 200

And this is what the output looks like if the response is malformed.

✗ Invalid response. Received  as body, expected b320aef5-dc43-5c42-e93e-9be75882a38c
✔ Valid status code. Received status 204

List of events you can subscribe to

The following is the list of events that you can subscribe to. Specify these as arguments of the verify-subscription sub-command.

Flags to use when verifying your web server