{"id":31801264,"url":"https://github.com/winstxnhdw/telefy","last_synced_at":"2026-05-15T01:35:17.158Z","repository":{"id":313263639,"uuid":"921128795","full_name":"winstxnhdw/telefy","owner":"winstxnhdw","description":"A generic notification API server for Telegram.","archived":false,"fork":false,"pushed_at":"2025-10-07T21:03:26.000Z","size":461,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-07T23:21:47.590Z","etag":null,"topics":["bun","cloudflare-workers","elysiajs","grammyjs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/winstxnhdw.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-23T11:46:36.000Z","updated_at":"2025-10-07T21:03:31.000Z","dependencies_parsed_at":"2025-09-04T23:26:48.669Z","dependency_job_id":"db3983f5-dfec-496f-bae8-0b35f480b572","html_url":"https://github.com/winstxnhdw/telefy","commit_stats":null,"previous_names":["winstxnhdw/telefy"],"tags_count":0,"template":false,"template_full_name":"winstxnhdw/cloudflare-worker-boilerplate","purl":"pkg:github/winstxnhdw/telefy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winstxnhdw%2Ftelefy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winstxnhdw%2Ftelefy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winstxnhdw%2Ftelefy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winstxnhdw%2Ftelefy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/winstxnhdw","download_url":"https://codeload.github.com/winstxnhdw/telefy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winstxnhdw%2Ftelefy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005575,"owners_count":26083921,"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-10-10T02:00:06.843Z","response_time":62,"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":["bun","cloudflare-workers","elysiajs","grammyjs"],"created_at":"2025-10-10T23:58:05.820Z","updated_at":"2026-05-15T01:35:17.146Z","avatar_url":"https://github.com/winstxnhdw.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# telefy\n\n[![main.yml](https://github.com/winstxnhdw/telefy/actions/workflows/main.yml/badge.svg)](https://github.com/winstxnhdw/telefy/actions/workflows/main.yml)\n[![deploy.yml](https://github.com/winstxnhdw/telefy/actions/workflows/deploy.yml/badge.svg)](https://github.com/winstxnhdw/telefy/actions/workflows/deploy.yml)\n[![formatter.yml](https://github.com/winstxnhdw/telefy/actions/workflows/formatter.yml/badge.svg)](https://github.com/winstxnhdw/telefy/actions/workflows/formatter.yml)\n\n`telefy` is a Cloudflare Worker that submits generic notifications to the Telegram API.\n\n## Usage\n\n`POST` **`/`** `(send notification)`\n\n### Request Headers\n\n\u003e | name          |  type    | description                       |\n\u003e | ------------- | -------- | --------------------------------- |\n\u003e | Authorization | required | `AUTH_TOKEN` environment variable |\n\n### Parameters\n\n#### NotificationSchema\n\n\u003e | name        |  type    | data type      | description                   |\n\u003e | ----------- | -------- | ---------------| ----------------------------- |\n\u003e | subject     | required | `string`       | notification subject          |\n\u003e | body        | required | `string`       | notification body             |\n\u003e | attachments | optional | `File[]`       | array of files to attach      |\n\n### Responses\n\n\u003e | http code | content-type | reason                          |\n\u003e | --------- | ------------ | ------------------------------- |\n\u003e | `200`     | `text/plain` | notification sent successfully  |\n\u003e | `400`     | `text/plain` | invalid request body            |\n\u003e | `401`     | `text/plain` | invalid authentication token    |\n\n### Example cURL\n\n\u003e ```bash\n\u003e curl $TELEFY_ENDPOINT\n\u003e   -H \"Authorization: Bearer $AUTH_TOKEN\" \\\n\u003e   -F \"subject=Title\" \\\n\u003e   -F \"body=This is the body of the notification.\" \\\n\u003e   -F \"attachments=@/path/to/file1\" \\\n\u003e   -F \"attachments=@/path/to/file2\"\n\u003e ```\n\n### Example AIOHTTP\n\n\u003e ```python\n\u003e async with ClientSession(headers={'Authorization': f'Bearer {env[\"AUTH_TOKEN\"]}'}) as session:\n\u003e     form_data = FormData()\n\u003e     form_data.add_field('subject', 'Hello World')\n\u003e     form_data.add_field('body', 'This is the body of the notification.')\n\u003e     form_data.add_field('attachments', image, filename='image.jpg', content_type='image/jpeg')\n\u003e\n\u003e     async with session.post(env['TELEFY_ENDPOINT'], data=form_data) as response:\n\u003e         response.raise_for_status()\n\u003e ```\n\n### Example HTTPX\n\n\u003e ```python\n\u003e async with AsyncClient() as client:\n\u003e     await client.post(env['TELEFY_ENDPOINT'],\n\u003e         headers={\"Authorization\": f\"Bearer {env['AUTH_TOKEN']}\"},\n\u003e         data={\"subject\": \"Hello World\", \"body\": \"This is the body of the notification.\"},\n\u003e         files=[(\"attachments\", (\"image.jpg\", image, \"image/jpeg\"))],\n\u003e     )\n\u003e ```\n\n## Setup\n\nPopulate the following environment variables in your Cloudflare Worker\n\n```bash\n{\n  echo \"AUTH_TOKEN=$AUTH_TOKEN\"\n  echo \"TELEGRAM_BOT_TOKEN=$TELEGRAM_BOT_TOKEN\"\n  echo \"TELEGRAM_CHAT_ID=$TELEGRAM_CHAT_ID\"\n} \u003e .dev.vars\n```\n\n## Development\n\nInstall all dependencies.\n\n```bash\nbun install\n```\n\nRun the development server.\n\n```bash\nbun dev\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinstxnhdw%2Ftelefy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwinstxnhdw%2Ftelefy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinstxnhdw%2Ftelefy/lists"}