mirror/Radarr
1
0
Fork 0
mirror of https://github.com/Radarr/Radarr synced 2024-12-21 23:42:23 +00:00
Code Issues Releases Wiki Activity
Page: Webhook Schema
Pages
API API:Calendar API:Command API:Diskspace API:History API:List Exclusions API:Movie Lookup API:Movie API:Queue API:System Status AppData Directory Autostart on Linux Backup and Restore Built In Qualities Clear Cache Cookies and Local Storage Command Line Options Common Problems Connections Create a Folder for Each Movie Custom Formats Aphrodite Custom Formats Examples Custom Formats Custom Post Processing Scripts Docker FAQ Health Checks Home How to Create a Folder for Each Movie How to make sure Radarr doesn't snatch full Blu Rays Import Plex Movie Database to Radarr Importing IMDb lists into TMDb Indexer Flags Installation Installing Multiple Instances of Radarr on Windows Mass Delete via API Minimum Availability New Profiles Release Branches Remote Path Mappings explained Reverse Proxy Running Multiple Instances on Windows Setup Guide Sorting and Renaming Supported DownloadClients Supported Indexers Supported NetImports Supported Notifications Twitter Notifications Useful Tools Users Guide Webhook Schema Webhook
3 Webhook Schema
Leonardo Galli edited this page 2017-11-19 11:55:01 +01:00
Table of Contents

Overview

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

Schema

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "RadarrEvent",
    "description": "Radarr Webhook Event",
    "type": "object",
    "anyOf": [
        {
            "properties": {
                "eventType": { "enum": ["Grab"] }
            },
            "required": ["eventType", "movie", "remoteMovie", "release"]
        },
        {
            "properties": {
                "eventType": { "enum": ["Download"] }
            },
            "required": ["eventType", "movie", "remoteMovie", "movieFile", "isUpgrade"]
        },
        {
            "properties": {
                "eventType": { "enum": ["Rename"] }
            },
            "required": ["eventType", "movie"]
        },
        {
            "properties": {
                "eventType": { "enum": ["Test"] }
            },
            "required": ["eventType", "movie", "remoteMovie", "release"]
        }
    ],
    "properties":{
        "eventType": { "enum": ["Download", "Grab", "Rename", "Test"] },
        "movie": {
            "type": "object",
            "required": ["id", "title", "releaseDate"],
            "properties": {
                "id": { "type": "integer", "minimum": 1 },
                "title": { "type": "string" },
                "releaseDate": { "type": "string", "format": "date" }
            }
        },
        "remoteMovie": {
            "type": "object",
            "required": ["title", "year"],
            "properties": {
                "title": { "type": "string" },
                "year": { "type": "integer", "minimum": 1800 },
                "tmdbId": { "type": "integer" },
                "imdbId": {"type": "string" }
            }
        },
        "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}
            }
        },
        "movieFile": {
            "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

API