Activities

Activity Types

Type

Provider

follow

Twitch

tip

Twitch & Youtube

host

Twitch

subscriber

Twitch & YouTube

cheer

Twitch

redemption

Twitch

sponsor

YouTube

superchat

YouTube

Activity Type

{
channel: Number;
type: String;
provider: String;
providerId: String;
createdAt: Date;
flagged: Boolean;
data: {
username: String;
tier: String;
currency: String;
amount: Number
message: String;
avatar: String;
sender: String;
gifted: Boolean;
}
}

get
Get activities for a channel

https://api.streamelements.com/kappa/v2/activities/:channel
This endpoint retrieves the activities for a channel.
Request
Response
Path Parameters
channel
required
string
account/channel ID
Headers
authorization
required
Authorization bearer token
Query Parameters
after
optional
string
An ISO8601 date string.
before
optional
string
An ISO8601 date string
username
optional
string
Search activities for a specific username
limit
optional
number
Limit the number of activities to return (default 100 when no limit is specified)
offset
optional
number
Pagination offset
types
required
string
Types can be added to only return specific types of activities
200: OK
Activities successfully retrieved.
[
{
"_id": "59e25ed28f25ce00010a0212",
"channel": "59e10187207b2900014d14d9",
"type": "tip",
"data": {
"tipId": "59e25ed28f25ce00010a0211",
"username": "xd",
"amount": 21,
"currency": "USD",
"message": "NaM"
},
"createdAt": "2017-10-14T19:00:34.324Z",
"provider": "twitch"
}
]
302: Found
401: Unauthorized
403: Forbidden
404: Not Found
Could not find a cake matching this query.
{
"statusCode": 404,
"error": "Not Found"
}

get
Get a single activity for a channel

https://api.streamelements.com/kappa/v2/activities/:channel/:activityId
This endpoint retrieves a single activity for a channel.
Request
Response
Path Parameters
channel
required
string
account/channel ID
activityId
required
string
activity ID
Headers
authorization
required
Authorization bearer token
200: OK
{
"_id": "59e25ed28f25ce00010a0212",
"channel": "59e10187207b2900014d14d9",
"type": "tip",
"data": {
"tipId": "59e25ed28f25ce00010a0211",
"username": "xd",
"amount": 21,
"currency": "USD",
"message": "NaM"
},
"createdAt": "2017-10-14T19:00:34.324Z",
"provider": "twitch"
}
400: Bad Request
{
"statusCode": 400,
"error": "Bad Request",
"message": "child \"channel\" fails because [\"channel\" with value \"57209398234\" fails to match the required pattern: /^[0-9a-fA-F]{24}$/]",
"details": [
{
"path": [
"channel"
],
"message": "\"channel\" with value \"57209398234\" fails to match the required pattern: /^[0-9a-fA-F]{24}$/"
}
]
}
401: Unauthorized
{
"statusCode": 401,
"error": "Unauthorized",
"message": "No authorization token was found"
}
403: Forbidden
404: Not Found
{
"statusCode": 404,
"error": "Not Found"
}

post
Replay an activity

https://api.streamelements.com/kappa/v2/activities/:channel/:activityId/replay
This endpoint will replay the alert for an activity.
Request
Response
Path Parameters
channel
required
string
account/channel ID
activityId
required
string
activity ID
Headers
authorization
required
string
Authorization bearer token
200: OK
{"success":true}
304: Not Modified
400: Bad Request
401: Unauthorized
403: Forbidden
404: Not Found
500: Internal Server Error
503: Service Unavailable