mirror
/
Sonarr
mirror of https://github.com/Sonarr/Sonarr
1
0
Fork 0
Code Issues Releases Wiki Activity
Page: Webhook Schema
Pages
Anime naming scheme AppData Directory Asking for Help Backup and Restore Cannot install update because startup folder is not writable by the user Command Line Options Completed Download Handling Configuration Custom Lists Custom Post Processing Scripts Delay Profiles Disable Authentication Downloads and Importing FAQ Failed Download Handling Forgot my Password Health Checks Home Implementing a Torznab indexer Indexer Integration Indexer Seed Ratio Installation (v3 beta) Fedora 31 Installation CentOS 7 Installation CentOS 8 V3 Beta Installation CentOS 8 Language Profile Log Files Logging and Log Files Manual Episode Search Trace Log Manual Episode Search XML Output Manually Triggering Imports Master Migration Monitoring Series and Episodes Problematic Shows Profiles PushOver Quality Profile RSS Sync Recovering from a Failed Update Release Branches Reverse Proxy Reverse symlink script for Connect SSL Searches Indexers and Trackers Sonarr notifications in Slack using curl Sorting and Renaming Specifying install user on Deb Ubu Supported DownloadClients Supported Indexers Supported Notifications Tips and Tricks Twitter Notifications Updating Webhook Schema Webhook
4 Webhook Schema
bakerboy448 edited this page 2022-02-28 06:44:23 -06:00
Table of Contents

Note: this is the Legacy v2 Wiki. The new V3 Wiki can be found at the Servarr Wiki. Sonarr v2 is end of life and not supported.

Overview

This page provides a JSON schema for validating events received from Sonarr's Webhook.

Schema

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "SonarrEvent",
    "description": "Sonarr Webhook Event",
    "type": "object",
    "anyOf": [
        {
            "properties": {
                "eventType": { "enum": ["Grab"] }
            },
            "required": ["eventType", "series", "episodes", "release"]
        },
        {
            "properties": {
                "eventType": { "enum": ["Download"] }
            },
            "required": ["eventType", "series", "episodes", "episodeFile", "isUpgrade"]
        },
        {
            "properties": {
                "eventType": { "enum": ["Rename"] }
            },
            "required": ["eventType", "series"]
        },
        {
            "properties": {
                "eventType": { "enum": ["Test"] }
            },
            "required": ["eventType", "series", "episodes"]
        }
    ],
    "properties":{
        "eventType": { "enum": ["Download", "Grab", "Rename", "Test"] },
        "series": {
            "type": "object",
            "required": ["id", "title", "path"],
            "properties": {
                "id": { "type": "integer", "minimum": 1 },
                "title": { "type": "string" },
                "path": { "type": "string" },
                "tvdbId": { "type": "integer", "minimum": 1 }
            }
        },
        "episodes": {
            "type": ["array", "null"],
            "minItems": 1,
            "items": {
                "type": "object",
                "required": ["id", "episodeNumber", "seasonNumber", "title"],
                "properties": {
                    "id": { "type": "integer", "minimum": 0 },
                    "episodeNumber": { "type": "integer", "minimum": 0 },
                    "seasonNumber": { "type": "integer", "minimum": 0 },
                    "title": { "type": "string" },
                    "airDate": { "type": "string", "format": "date" },
                    "airDateUtc": { "type": "string", "format": "date-time" },
                    "quality": { "type": "string", "description": "Deprecated: will be removed in a future version" },
                    "qualityVersion": { "type": "integer", "minimum": 1, "description": "Deprecated: will be removed in a future version" },
                    "releaseGroup": { "type": "string", "description": "Deprecated: will be removed in a future version" },
                    "sceneName": { "type": "string", "description": "Deprecated: will be removed in a future version" }
                }
            }
        },
        "release": {
            "type": "object",
            "properties": {
                "quality": { "type": "string"},
                "qualityVersion": { "type": "integer", "minimum": 1 },
                "releaseGroup": { "type": "string" },
                "releaseTitle": { "type": "string" },
                "indexer": { "type": "string" },
                "size": { "type": "integer", "minimum": 0}
            }
        },
        "episodeFile": {
            "type": "object",
            "required": ["id", "relativePath", "path"],
            "properties": {
                "id": { "type": "integer", "minimum": 1 },
                "relativePath": { "type": "string" },
                "path": { "type": "string" },
                "quality": { "type": "string" },
                "qualityVersion": { "type": "integer", "minimum": 1 },
                "releaseGroup": { "type": "string" },
                "sceneName": { "type": "string" }
            }
        },
        "isUpgrade": { "type": "boolean" }
    }
}

Getting Started

Troubleshooting

Additional Configuration

More Information

Development

API