GET
/
webhook
/
push-notification
/
video-streaming.started
Video Streaming Started webhook event
curl --request GET \
  --url https://apix.us.amity.co/webhook/push-notification/video-streaming.started \
  --header 'Authorization: Bearer <token>'
{
  "eventType": "push-notification.created",
  "id": "<string>",
  "networkId": "<string>",
  "path": "<string>",
  "senderId": "<string>",
  "sentTime": "2023-11-07T05:31:56Z",
  "version": "<string>",
  "data": {
    "videoStreamings": [
      {
        "streamId": "<string>",
        "userId": "<string>",
        "thumbnailFileId": "<string>",
        "title": "<string>",
        "status": "idle",
        "isLive": true,
        "isDeleted": true,
        "description": "<string>",
        "platform": {
          "name": "<string>",
          "version": "<string>"
        },
        "startedAt": "2023-11-07T05:31:56Z",
        "endedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "metadata": {},
        "resolution": "SD",
        "streamerUrl": {
          "url": "<string>",
          "components": {
            "origin": "<string>",
            "appName": "<string>",
            "streamName": "<string>",
            "query": "<string>"
          }
        }
      }
    ],
    "users": [
      {
        "_id": "<string>",
        "path": "<string>",
        "userId": "<string>",
        "userInternalId": "<string>",
        "userPublicId": "<string>",
        "roles": [
          "<string>"
        ],
        "permissions": [
          "MUTE_CHANNEL"
        ],
        "displayName": "<string>",
        "profileHandle": "<string>",
        "description": "<string>",
        "avatarFileId": "<string>",
        "avatarCustomUrl": "<string>",
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "metadata": {},
        "isGlobalBan": true,
        "isBrand": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isDeleted": true
      }
    ],
    "files": [
      {
        "fileId": "<string>",
        "fileUrl": "<string>",
        "type": "image",
        "accessType": "public",
        "altText": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "attributes": {
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mimeType": "<string>",
          "metadata": {
            "exif": {},
            "gps": {},
            "height": 123,
            "width": 123,
            "isFull": true
          }
        }
      }
    ],
    "eventName": "<string>",
    "isBroadcast": true,
    "targetIds": [
      "<string>"
    ],
    "notify": true,
    "title": "<string>",
    "body": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

video-streaming is started

The response is of type object.