Mirrors/Radarr
1
0
Fork 0
mirror of https://github.com/Radarr/Radarr.git synced 2024-07-02 10:22:21 +02:00
Code Issues Releases Wiki Activity

Updated Webhook (markdown)

fhscholl 2017-11-01 00:58:06 -04:00
parent 1bf4278064
commit 11157b15c7
1 changed files with 113 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
Webhook.md

@ -1 +1,114 @@
If you're looking to notify a web service to indicate when Radarr has done things, you can find more details here:
### Overview ###
Radarr can notify a web service using `POST` or `PUT` when new episodes are imported, renamed, or grabbed.
Parameters are passed to the web service as a JSON body.
Representative payloads for each event type are below. There is also a [JSON schema](https://github.com/Radarr/Radarr/wiki/Webhook-Schema) available.
### Example Payload ###
##### On Grab #####
```json
{
"eventType": "Grab",
"movie": {
"id": 2,
"title": "Finding Nemo",
"releaseDate": "2003-08-28"
},
"remoteMovie": [
{
"tmdbId": 12,
"imdbId": "tt0266543",
"title": "Finding Nemo",
"year": 2003
}
],
"release": {
"quality": "DVD",
"qualityVersion": 1,
"releaseGroup": "XME",
"releaseTitle": "Finding.Nemo.2003.iNTERNAL.DVDRip.x264-XME",
"indexer": "NZBgeek",
"size": 2172672000
}
}
```
##### On Download/On Upgrade #####
```json
{
"eventType": "Download",
"movie": {
"id": 2,
"title": "Finding Nemo",
"releaseDate": "2003-08-28"
},
"remoteMovie": [
{
"tmdbId": 12,
"imdbId": "tt0266543",
"title": "Finding Nemo",
"year": 2003
}
],
"movieFile": {
"id": 2,
"relativePath": "Finding Nemo (2003) DVD.mkv",
"path": "Z:\\Finding.Nemo.2003.iNTERNAL.DVDRip.x264-REGRET\\regret-nemo.mkv",
"quality": "DVD",
"qualityVersion": 1,
"releaseGroup": "REGRET"
},
"isUpgrade": false
}
```
##### On Rename #####
```json
{
"eventType": "Rename",
"movie": {
"id": 2,
"title": "Finding Nemo",
"releaseDate": "2003-08-28"
}
}
```
##### On Test #####
```json
{
"eventType": "Test",
"movie": {
"id": 1,
"title": "Test Title",
"releaseDate": "1970-01-01"
},
"remoteMovie": {
"tmdbId": 1234,
"imdbId": "5678",
"title": "Test title",
"year": 1970
},
"release": {
"quality": "Test Quality",
"qualityVersion": 1,
"releaseGroup": "Test Group",
"releaseTitle": "Test Title",
"indexer": "Test Indexer",
"size": 9999999
}
}
```
##### Sample/Example Apps/Usage ####
TODO