Restream · Schema

Event

A Restream live streaming event, which can be scheduled, in-progress, or historical.

BroadcastChatContent DeliveryLive StreamingMultistreamingVideo Streaming

Properties

Name Type Description
id string Unique event identifier
title string Event title displayed across all streaming platforms
description string Event description
status string Current status of the event
startedAt stringnull ISO 8601 timestamp when the event started
endedAt stringnull ISO 8601 timestamp when the event ended
channels array List of channel IDs included in this event
View JSON Schema on GitHub

JSON Schema

restream-event-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.restream.io/schemas/event",
  "title": "Event",
  "description": "A Restream live streaming event, which can be scheduled, in-progress, or historical.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique event identifier"
    },
    "title": {
      "type": "string",
      "description": "Event title displayed across all streaming platforms"
    },
    "description": {
      "type": "string",
      "description": "Event description"
    },
    "status": {
      "type": "string",
      "enum": ["upcoming", "in-progress", "completed"],
      "description": "Current status of the event"
    },
    "startedAt": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "ISO 8601 timestamp when the event started"
    },
    "endedAt": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "ISO 8601 timestamp when the event ended"
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "List of channel IDs included in this event"
    }
  },
  "required": ["id", "status"],
  "additionalProperties": false
}