JSON Schemas (draft 2020-12) for every event’s data, the shared references, and the envelope. Each page here is a readable view of the JSON beside it; the JSON is what an event’s dataschema points to. See the specification for how the schemas are versioned. A machine-readable list is in index.json.
| Event | Stability | Description | Schema |
|---|---|---|---|
| app.started | stable | The app loaded. | JSON |
| app.foregrounded | stable | The app became visible. | JSON |
| app.backgrounded | stable | The app became hidden. | JSON |
| playback.started | stable | Playback of an episode began or resumed; opens a segment. | JSON |
| playback.paused | stable | Playback paused; closes the segment. | JSON |
| playback.progress | stable | Periodic segment state while playing. | JSON |
| playback.seeked | stable | The position jumped; closes the segment. | JSON |
| playback.ended | stable | The episode reached true end of media; closes the segment. | JSON |
| show.viewed | experimental | A show page or preview opened. | JSON |
| show.refreshed | stable | One feed refresh finished, outside a bulk refresh. | JSON |
| show.episodesFound | stable | A refresh found episodes that were not there before. | JSON |
| show.followed | stable | A show was followed. | JSON |
| show.unfollowed | stable | A show was unfollowed. | JSON |
| episode.viewed | experimental | An episode’s detail opened. | JSON |
| episode.downloaded | stable | A download completed. | JSON |
| episode.downloadFailed | stable | A download failed. | JSON |
| episode.downloadDeleted | stable | A downloaded file was removed. | JSON |
| episode.shown | experimental | An episode is visible on a recommendation surface. | JSON |
| episode.dismissed | experimental | The user marked an episode not interested. | JSON |
| episode.markedDone | stable | The user marked an episode done without finishing it. Not a listen. | JSON |
| queue.added | stable | An episode joined a queue. | JSON |
| queue.removed | stable | An episode left a queue without being played through. | JSON |
| search.performed | experimental | A search ran. Carries the query text; senders send it only on explicit opt-in. | JSON |
| library.snapshot | stable | The complete follow list, sent periodically. | JSON |
| library.refreshed | stable | A bulk refresh finished. | JSON |
| Schema | |
|---|---|
| Show reference | JSON |
| Episode reference | JSON |
| Playback segment | JSON |
| Event envelope | JSON |