Developer Surface

Comprehensive documentation, API references, webhook specifications, and code examples

API Reference

GET/api/v1/titlescatalog

Retrieve a list of titles with filtering and pagination

GET/api/v1/titles/{id}catalog

Get detailed information about a specific title

POST/api/v1/titles/{id}/likeinteractions

Like a title (requires authentication)

POST/api/v1/titles/{id}/super-likeinteractions

Super-like a title (requires authentication)

GET/api/v1/sessionssessions

List active and scheduled Duo sessions

POST/api/v1/sessionssessions

Create a new Duo session

POST/api/v1/sessions/{id}/joinsessions

Join an existing Duo session

GET/api/v1/webhookswebhooks

List registered webhooks for your application

POST/api/v1/webhookswebhooks

Register a new webhook endpoint

Webhook Specification

Overview

Webhooks allow you to receive real-time notifications about events in the Telly platform. Configure your webhook endpoints to receive POST requests when specific events occur.

Endpoint Requirements

  • Must accept POST requests
  • Must respond with 200 status code within 5 seconds
  • Must use HTTPS (TLS 1.2+)
  • Must verify webhook signatures for security

session.created

Triggered when a new Duo session is created

Example Payload:

{
  "session_id": "string",
  "host_id": "string",
  "created_at": "datetime"
}

session.started

Triggered when a session begins

Example Payload:

{
  "session_id": "string",
  "started_at": "datetime"
}

session.ended

Triggered when a session ends

Example Payload:

{
  "session_id": "string",
  "ended_at": "datetime",
  "duration": "number"
}

title.liked

Triggered when a title receives a like

Example Payload:

{
  "title_id": "string",
  "user_id": "string",
  "timestamp": "datetime"
}

sync.status.changed

Triggered when sync status changes in a session

Example Payload:

{
  "session_id": "string",
  "status": "string",
  "metrics": "object"
}

Changelog

API v2.1.0

March 10, 2024

Feature
  • Added new endpoints for enhanced session management
  • Improved webhook payload structure with additional metadata
  • Enhanced error responses with detailed error codes

API v2.0.5

February 28, 2024

Fix
  • Fixed pagination issues in title listing endpoints
  • Resolved webhook signature verification edge cases

Ready to Get Started?

Sign up for API access and start building with Telly today