These are the functions of this module:

• twitch_eventsub_create_eventsub_subscription
• twitch_eventsub_delete_eventsub_subscription
• twitch_eventsub_get_eventsub_subscriptions
• twitch_eventsub_live_connect
• twitch_eventsub_live_disconnect

Back To Top

Twitch Endpoint: Create EventSub Subscription

This function creates an EventSub subscription.

If you use webhooks to receive events, the request must specify an app access token. The request will fail if you use a user access token. If the subscription type requires user authorization, the user must have granted your app (client ID) permissions to receive those events before you subscribe to them. For example, to subscribe to channel.subscribe events, your app must get a user access token that includes the TWITCH_SCOPE_CHANNEL_READ_SUBSCRIPTIONS scope, which adds the required permission to your app access token's client ID.

If you use WebSockets to receive events, the request must specify a user access token. The request will fail if you use an app access token. If the subscription type requires user authorization, the token must include the required scope. However, if the subscription type doesn't include user authorization, the token may include any scopes or no scopes.

If you use Conduits to receive events, the request must specify an app access token. The request will fail if you use a user access token.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Success Callback, or Failure Callback.

Syntax:

twitch_eventsub_create_eventsub_subscription(type, version, condition, transport, method, optionals, callback_success, callback_failed)

Returns:

N/A

Triggers:

Success Callback

These members are returned in the success callback:

Failure Callback

This method is triggered on failure.

Back To Top

Twitch Endpoint: Delete EventSub Subscription

This function deletes an EventSub subscription.

If you use webhooks to receive events, the request must specify an app access token. The request will fail if you use a user access token.

If you use WebSockets to receive events, the request must specify a user access token. The request will fail if you use an app access token. The token may include any scopes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Success Callback, or Failure Callback.

Syntax:

twitch_eventsub_delete_eventsub_subscription(id, callback_success, callback_failed)

Returns:

N/A

Triggers:

Success Callback

This method is triggered on success. It has no response body.

Failure Callback

This method is triggered on failure.

Back To Top

Twitch Endpoint: Get EventSub Subscriptions

This function gets a list of EventSub subscriptions that the client in the access token created.

If you use Webhooks or Conduits to receive events, the request must specify an app access token. The request will fail if you use a user access token.

If you use WebSockets to receive events, the request must specify a user access token. The request will fail if you use an app access token. The token may include any scopes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Success Callback, or Failure Callback.

Syntax:

twitch_eventsub_get_eventsub_subscriptions(optionals, callback_success, callback_failed)

Returns:

N/A

Triggers:

Success Callback

These members are returned in the success callback:

Failure Callback

This method is triggered on failure.

Back To Top

Twitch Endpoint: N / A

This function creates a connection to be used with the "websocket" transport method of the EventSub functions.

The function takes a callback function with a single parameter: the Buffer that holds the received data.

eventsub_callback = function(_buffer)
{
    var _eventsub_str = buffer_read(_buffer, buffer_string);
    var _data = json_parse(_eventsub_str);

    switch(_data.metadata.message_type)
    {
        // Process different message types in a switch statement
        // ...
    }
}

This connection receives several types of message that should be handled correctly. See Handling WebSocket Events. See the demo project for a complete code example.

Syntax:

twitch_eventsub_live_connect(callback)

Returns:

Real

Back To Top

Twitch Endpoint: N / A

This function disconnects from the connection set up earlier using twitch_eventsub_live_connect.

Syntax:

twitch_eventsub_live_disconnect()

Returns:

N/A