mirror/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr synced 2024-12-22 07:43:01 +00:00
Code Issues Releases Wiki Activity

Created Webhook (markdown)

Gavin Mogan 2015-08-25 22:21:16 -07:00
parent f4979b8e3e
commit f1a422c51b
1 changed files with 75 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
Webhook.md Normal file

@ -0,0 +1,75 @@
If you're looking to notify a web service to indicate when Sonarr has done things, you can find more details here:
### Overview ###
Sonarr can notify a webservice using POST or PUT when new episodes are imported, a series is renamed, or new files are grabbed.
Parameters are passed to the webservice using a JSON body
### Example Outputs ###
##### On Download/On Upgrade #####
`
{
"EventType": "Download",
"Series": {
"Id": 2,
"Title": "Gravity Falls",
"Path": "C:\\Temp\\sonarr\\Gravity Falls",
"TvdbId": 259972
},
"EpisodeFile": {
"Id": 1,
"FullPath": "C:\\Temp\\sonarr\\Gravity Falls\\Season 2\\Gravity Falls - S02E14 - The Stanchurian Candidate.mkv",
"RelativePath": "Season 2\\Gravity Falls - S02E14 - The Stanchurian Candidate.mkv",
"SeasonNumber": 2,
"Episodes": [
{
"AirDate": null,
"AirDateUtc": null,
"EpisodeNumber": 0
}
],
"Quality": "HDTV-720p",
"QualityVersion": "1",
"ReleaseGroup": "",
"SceneName": ""
},
"Episode": null
}
`
##### On Grab #####
`
{
"EventType": "Grab",
"Series": {
"Id": 2,
"Title": "Gravity Falls",
"Path": "C:\\Temp\\sonarr\\Gravity Falls",
"TvdbId": 259972
},
"EpisodeFile": null,
"Episode": {
"AirDate": "2015-08-24",
"AirDateUtc": "2015-08-25T01:30:00Z",
"EpisodeNumber": 14
}
}
`
##### On Rename #####
`
{
"EventType": "Rename",
"Series": {
"Id": 2,
"Title": "Gravity Falls",
"Path": "C:\\Temp\\sonarr\\Gravity Falls",
"TvdbId": 259972
},
"EpisodeFile": null,
"Episode": null
}
`