{"id":28229359,"url":"https://github.com/solidcouch/solid-email-notifications-webhook","last_synced_at":"2026-05-07T16:41:11.428Z","repository":{"id":184251408,"uuid":"670659672","full_name":"solidcouch/solid-email-notifications-webhook","owner":"solidcouch","description":"(LEGACY, NOT MAINTAINED) Email notifications service for SolidCouch, hopefully useful generally","archived":false,"fork":false,"pushed_at":"2024-01-02T17:56:05.000Z","size":2453,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-05-07T06:44:30.693Z","etag":null,"topics":["solid-project"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/solidcouch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-07-25T14:42:00.000Z","updated_at":"2025-04-07T17:40:28.000Z","dependencies_parsed_at":"2023-10-15T18:56:31.822Z","dependency_job_id":"c5387042-6107-4eaa-8bb1-aa4b7e1286d0","html_url":"https://github.com/solidcouch/solid-email-notifications-webhook","commit_stats":{"total_commits":19,"total_committers":1,"mean_commits":19.0,"dds":0.0,"last_synced_commit":"38bc45b823abd3bf1ed07e4ed4b39785a0e221ac"},"previous_names":["openhospitalitynetwork/solid-email-notifications","solidcouch/solid-email-notifications","solidcouch/solid-email-notifications-webhook"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/solidcouch/solid-email-notifications-webhook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidcouch%2Fsolid-email-notifications-webhook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidcouch%2Fsolid-email-notifications-webhook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidcouch%2Fsolid-email-notifications-webhook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidcouch%2Fsolid-email-notifications-webhook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/solidcouch","download_url":"https://codeload.github.com/solidcouch/solid-email-notifications-webhook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidcouch%2Fsolid-email-notifications-webhook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32746528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["solid-project"],"created_at":"2025-05-18T16:10:16.603Z","updated_at":"2026-05-07T16:41:11.395Z","avatar_url":"https://github.com/solidcouch.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Solid email notifications\n\nThis service sends you an email when a new notification arrives to your Solid Pod inbox\n\n## How it works\n\n- It's a bot agent with its own identity, which must be provided by arbitrary CommunitySolidServer pod\n- It runs on a server\n- At the beginning of the integration, the bot's webId must be given Read access to your inbox (frontend app can take care of this by editing inbox's .acl (access control list))\n- You have to prove that the inbox belongs to you (how to prove that? not implemented, yet)\n- You have to tell the service where to send you emails\n  - in the future, the email address might be stored in your pod; for now we keep it in internal database\n- You receive email with verification link and follow the link\n- The service then subscribes to Solid [webhook](https://solid.github.io/notifications/webhook-channel-2023) [notifications](https://solidproject.org/TR/notifications-protocol) of your inbox\n- When a notification arrives to your inbox, this agent gets notified by the webhook and sends you email via a configured email service. In the future it will also check whether it's a notification about something specific (in the context of sleepy.bike e.g. message or contact request), it'll compose the message and send it to you\n- It will regularly re-subscribe to your inbox because some Solid pods drop the subscription regularly (not implemented, yet)\n- If your pod doesn't support webhook notifications, maybe this bot will check your inbox regularly (a few times per day) and send you a notification when it finds something new there (not implemented, yet)\n\n## Usage\n\n### Configure\n\nTo authenticate itself, the mailer needs to have its own identity, it can be identity hosted on some Community Solid Server\n\nCopy `.env.sample` to `.env` and edit the latter according to your needs\n\nAlternatively, you may provide the configuration as environment variables\n\nYou can find full list of config options in [.env.sample](./.env.sample)\n\n### Run\n\n```sh\nyarn start\n```\n\n### Use\n\nService API is documented in [OpenAPI schema](./apidocs/openapi.json) (still work in progress). When you run the app with `yarn start`, you'll see the Swagger-UI documentation at `/`.\n\nTo integrate this service with person's inbox, the mailer identity needs to be given Read access to that inbox. You can do it via a frontend app, or manually by updating inbox acl.\n\n#### GET /status\n\nSee whether the current user has integrated inbox with the service\n\n#### POST /inbox\n\nIntegrate person's inbox with the service\n\n#### GET /verify-email\n\nVerify email during integration\n\n#### POST /webhook-receiver\n\nListen to webhook notifications coming from Solid pod when inbox changes\n\n## Tests\n\nRun `yarn test`\n\nTests are placed in [src/test/](./src/test/)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidcouch%2Fsolid-email-notifications-webhook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidcouch%2Fsolid-email-notifications-webhook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidcouch%2Fsolid-email-notifications-webhook/lists"}