{"id":16915061,"url":"https://github.com/ryancurrah/synology-notifications","last_synced_at":"2025-07-29T13:15:03.489Z","repository":{"id":51286071,"uuid":"188343467","full_name":"ryancurrah/synology-notifications","owner":"ryancurrah","description":"Synology notifications service","archived":false,"fork":false,"pushed_at":"2023-07-22T13:03:18.000Z","size":764,"stargazers_count":72,"open_issues_count":2,"forks_count":9,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-02T04:35:12.542Z","etag":null,"topics":["diskstation","dsm","notifcation-service","notifications","slack","synology","synology-notifications"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryancurrah.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-24T03:05:26.000Z","updated_at":"2025-01-18T16:02:46.000Z","dependencies_parsed_at":"2024-06-18T22:52:29.484Z","dependency_job_id":"c6cdcc0d-92ef-4e3c-9702-7d8068abb694","html_url":"https://github.com/ryancurrah/synology-notifications","commit_stats":{"total_commits":17,"total_committers":2,"mean_commits":8.5,"dds":"0.11764705882352944","last_synced_commit":"48a63dbca7ac043a12fe1a9bd55ac3ccba6f7fb0"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ryancurrah/synology-notifications","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancurrah%2Fsynology-notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancurrah%2Fsynology-notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancurrah%2Fsynology-notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancurrah%2Fsynology-notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryancurrah","download_url":"https://codeload.github.com/ryancurrah/synology-notifications/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancurrah%2Fsynology-notifications/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267693799,"owners_count":24129137,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diskstation","dsm","notifcation-service","notifications","slack","synology","synology-notifications"],"created_at":"2024-10-13T19:16:22.751Z","updated_at":"2025-07-29T13:15:03.442Z","avatar_url":"https://github.com/ryancurrah.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# synology-notifications\n\nReceive notifications from Synology and forward them to the notification service of your choice\n\n## Supported notification services\n\n- Slack\n\n## Service settings\n\nSettings are supplied by setting environment variables\n\n- `API_KEY`: A minimum of 32 character api key that Synology server needs to use to auth to this services api\n- `LISTEN_PORT`: Default `8080`. The port the service will listen on \n\n## Slack settings\n\n- `SLACK_WEBHOOK`: URL for the Slack web hook\n- `SLACK_ATTACHMENT_COLOR`: Color to use for the attachments can use hex `#36a64f`\n\n## Cmd\n\n```bash\nexport API_KEY='LO45UXS%amLAWJn6CwJ1koaXW\u00267pY9#Z'\nexport SLACK_WEBHOOK='https://slack.com/myWebHookUrl'\n./synology-notifications\nlistening on port 8080\n```\n\n## Docker\n\n```bash\ndocker run -e API_KEY='LO45UXS%amLAWJn6CwJ1koaXW\u00267pY9#Z' -e SLACK_WEBHOOK='https://slack.com/myWebHookUrl' -p 8080:8080 ryancurrah/synology-notifications:latest\nlistening on port 8080\n```\n\n## Setting up Synology\n\n1. Login to Diskstation\n2. Go to `Control Pannel` \u003e `Notification` \u003e `SMS`\n3. Check `Enable SMS Notifications`\n4. Click `Add SMS Provider` to create a new SMS provider which will be the `synology-notifications` service. (**NOTE**: We will not actually be using `SMS`)\n    1. **Provider Name**: `synology-notifications`\n    2. **SMS URL**: `http://\u003cip address of synology-notifications service\u003e:8080`\n    3. **HTTP Method**: `POST`\n5. Click `Next` to go to the `Edit HTTP Request Header` page\n5. Click `Add` and set the `Parameter` to `api_key` and leave `Value` empty\n6. Click `Next` to go to the `Edit HTTP Request Body` page\n6. Click `Add` and set the `Parameter` to `phone_number` and leave `Value` empty (**NOTE**: Synology requires this field to exist even though it's not used)\n7. Click `Add` and set the `Parameter` to `message` set the `Value` to `Hello world` (**NOTE**: Synology requires a sample value)\n8. Click `Next` to go to the `Select the corrosponding category for each parameter` page\n8. Set the type of the `api_key` Parameter to `API Key`\n9. Set the type of the `phone_number` Parameter to `Phone Number`\n10. Set the type of the `message` Parameter to `Message content`\n11. Click `Apply`\n11. Select `synology-notifications` from the `SMS service provider` dropdown\n12. In the `API Key` field paste the API Key you choose for the service\n13. Click `Apply`\n13. Test the notification service by clicking `Send a test SMS message`\n\n## Setting up Synology with screenshots\n\n![Step 1](https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_1.png?raw=true)\n\n![Step 2](https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_2.png?raw=true)\n\n![Step 3](https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_3.png?raw=true)\n\n![Step 4](https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_4.png?raw=true)\n\n![Step 5](https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_5.png?raw=true)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryancurrah%2Fsynology-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryancurrah%2Fsynology-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryancurrah%2Fsynology-notifications/lists"}