Skip to content

Commit ab9d63e

Browse files
committed
update eventsub docs
1 parent d8dc852 commit ab9d63e

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/changelog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Master
2323
- Fix auto reconnect of websocket. Created tasks by asyncio.create_task() need to be referred to prevent task disappearing (garbage collection).
2424

2525
- ext.eventsub
26+
- Documentation
27+
- Updated quickstart example to reflect proper usage of callback
2628
- Additions
2729
- Updated docs regarding new HypeTrain contribution method ``other`` for :attr:`~twitchio.ext.eventsub.HypeTrainContributor.type`
2830
- Added Shield Status events

docs/exts/eventsub.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Twitch will send you an HTTP request containing information on the event. This e
1111
integrating seamlessly into the twitchio Client event dispatching system.
1212

1313
.. warning::
14-
This ext requires you to have a public facing ip, and to be able to receive inbound requests.
14+
This ext requires you to have a public facing ip AND domain, and to be able to receive inbound requests.
1515

1616
.. note::
1717
Twitch requires EventSub targets to have TLS/SSL enabled (https). TwitchIO does not support this, as such you should
@@ -26,7 +26,7 @@ A Quick Example
2626
import twitchio
2727
from twitchio.ext import eventsub, commands
2828
bot = commands.Bot(token="...")
29-
eventsub_client = eventsub.EventSubClient(bot, "some_secret_string", "/callback")
29+
eventsub_client = eventsub.EventSubClient(bot, "some_secret_string", "https://your-url.here/callback")
3030
# when subscribing (you can only await inside coroutines)
3131
3232
await eventsub_client.subscribe_channel_subscriptions(channel_ID)

0 commit comments

Comments
 (0)