{"id":15016767,"url":"https://github.com/kha7iq/pingme-action","last_synced_at":"2025-04-12T10:41:44.749Z","repository":{"id":65160470,"uuid":"359109804","full_name":"kha7iq/pingme-action","owner":"kha7iq","description":"PingMe action enables you to send messages or alerts to multiple messaging platforms \u0026 email.","archived":false,"fork":false,"pushed_at":"2021-08-12T17:28:23.000Z","size":11,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-23T04:01:50.178Z","etag":null,"topics":["discord","email","github-actions","gotify","line","mastodon","mattermost","msteams","pushbullet","pushover","rocketchat","slack","telegram","textmagic","wechat","zulip"],"latest_commit_sha":null,"homepage":"https://pingme.lmno.pk","language":null,"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/kha7iq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-18T10:19:44.000Z","updated_at":"2021-09-30T15:04:09.000Z","dependencies_parsed_at":"2023-01-13T15:43:56.292Z","dependency_job_id":null,"html_url":"https://github.com/kha7iq/pingme-action","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"386ddd1c8c5aac910c466181101b8170f46a875f"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kha7iq","download_url":"https://codeload.github.com/kha7iq/pingme-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248556863,"owners_count":21124156,"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","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":["discord","email","github-actions","gotify","line","mastodon","mattermost","msteams","pushbullet","pushover","rocketchat","slack","telegram","textmagic","wechat","zulip"],"created_at":"2024-09-24T19:49:21.452Z","updated_at":"2025-04-12T10:41:44.709Z","avatar_url":"https://github.com/kha7iq.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch2 align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003cp align=\"center\"\u003e\u003cimg width=20% src=\"https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png\"\u003e\u003c/p\u003e\n\u003c/h2\u003e\n\n\n\u003cp align=\"center\"\u003e\n   \u003ca href=\"https://github.com/kha7iq/pingme-action/releases\"\u003e\n   \u003cimg alt=\"Release\" src=\"https://img.shields.io/github/v/release/kha7iq/pingme-action\"\u003e\n   \u003ca href=\"https://hub.docker.com/r/khaliq/pingme\"\u003e\n   \u003cimg alt=\"Docker Image Size (latest by date)\" src=\"https://img.shields.io/docker/image-size/khaliq/pingme\"\u003e\n   \u003ca href=\"#\"\u003e\n   \u003cimg alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/kha7iq/pingme-action\"\u003e\n   \u003ca href=\"https://github.com/kha7iq/pingme-action/issues\"\u003e\n   \u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/kha7iq/pingme-action?style=flat-square\u0026logo=github\u0026logoColor=white\"\u003e\n   \u003ca href=\"https://github.com/kha7iq/pingme-action/blob/master/LICENSE.md\"\u003e\n   \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/kha7iq/pingme-action\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## PingMe Github Action\n\n**PingMe Github Action** is based on the utility  [**PingMe**](https://github.com/kha7iq/pingme). It provides the ability to send messages or alerts to multiple messaging platforms and also email.\n\nYou can view the [**PingMe Documentation**](https://pingme.lmno.pk) for complete configurations.\n\n## Supported services\n\n  - [Telegram](#telegram)\n  - [Pushover](#pushover)\n  - [PushBullet](#pushbullet)\n  - [Slack](#slack)\n  - [RocketChat](#rocketchat)\n  - [Discord](#discord)\n  - [Email](#email)\n  - [Microsoft Teams](#microsoft-teams)\n  - [Mattermost](#mattermost)\n  - [Twillio](#twillio)\n  - [Gotify](#gotify)\n  - [Line](#line)\n  - [Mattermost](#mattermost-1)\n  - [Mastodon](#mastodon)\n  - [Textmagic](#textmagic)\n  - [WeChat](#wechat)\n  - [Zulip](#zulip)\n\n\n# Usage Example\n\n## Telegram\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}\n          TELEGRAM_CHANNELS: ${{ secrets.TELEGRAM_CHANNELS }}\n          TELEGRAM_TITLE: 'Reference: ${{ github.ref }}'\n          TELEGRAM_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        \n        with:\n          # Chose the messaging platform. \n          # slack / telegram / rocketchat / teams / pushover / discord / email / pushbullet / twillio\n          service: telegram\n```\n\n## Pushover\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          PUSHOVER_TOKEN: ${{ secrets.PUSHOVER_TOKEN }}\n          PUSHOVER_USER: ${{ secrets.PUSHOVER_USER }}\n          PUSHOVER_TITLE: 'Reference: ${{ github.ref }}'\n          PUSHOVER_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        \n        with:\n          service: pushover\n```\n\n## PushBullet\n\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          PUSHBULLET_TOKEN: ${{ secrets.PUSHBULLET_TOKEN }}\n          PUSHBULLET_DEVICE: ${{ secrets.PUSHBULLET_DEVICE }}\n          PUSHBULLET_TITLE: 'Reference: ${{ github.ref }}'\n          PUSHBULLET_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: pushbullet\n```\n\n## Slack\n```yaml\non:\n  release:\n    types: [published]\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n      \n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}\n          SLACK_CHANNELS: ${{ secrets.SLACK_CHANNELS }}\n          SLACK_MSG_TITLE: 'Reference: ${{ github.ref }}'\n          SLACK_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: slack\n```\n\n## RocketChat\n```yaml\non:\n  release:\n    types: [published]\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n      \n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          ROCKETCHAT_USERID: ${{ secrets.ROCKETCHAT_USERID }}\n          ROCKETCHAT_TOKEN: ${{ secrets.ROCKETCHAT_TOKEN }}\n          ROCKETCHAT_SERVER_URL: ${{ secrets.ROCKETCHAT_SERVER_URL }}\n          ROCKETCHAT_CHANNELS: ${{ secrets.ROCKETCHAT_CHANNELS }}\n          ROCKETCHAT_TITLE: 'Reference: ${{ github.ref }}'\n          ROCKETCHAT_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: rocketchat\n```\n## Discord\n```yaml\non:\n  release:\n    types: [published]\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n      \n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          DISCORD_TOKEN: ${{ secrets.DISCORD_TOKEN }}\n          DISCORD_CHANNELS: ${{ secrets.DISCORD_CHANNELS }}\n          DISCORD_MSG_TITLE: 'Reference: ${{ github.ref }}'\n          DISCORD_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: discord\n```\n\n## Email\n```yaml\non:\n  release:\n    types: [published]\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n      \n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          EMAIL_SENDER: ${{ secrets.EMAIL_SENDER }}\n          EMAIL_PASSWORD: ${{ secrets.EMAIL_PASSWORD }}\n          EMAIL_RECEIVER: ${{ secrets.EMAIL_RECEIVER }}\n          EMAIL_HOST: 'smtp.gmail.com'\n          EMAIL_PORT: '587'\n          EMAIL_SUBJECT: 'Reference: ${{ github.ref }}'\n          EMAIL_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: email\n```\n\n## Microsoft Teams\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          TEAMS_WEBHOOK: ${{ secrets.TEAMS_WEBHOOK }}\n          TEAMS_MSG_TITLE: 'Reference: ${{ github.ref }}'\n          TEAMS_MESSAGE: 'Event is triggered by ${{ github.event_name }}'   \n        with:\n          service: teams\n```\n\n## Mattermost\n\n```yaml\non:\n  release:\n    types: [published]\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          MATTERMOST_TOKEN: ${{ secrets.MATTERMOST_TOKEN }}\n          MATTERMOST_SERVER_URL: ${{ secrets.MATTERMOST_SERVER_URL }}\n          MATTERMOST_CHANNELS: ${{ secrets.MATTERMOST_CHANNELS }}\n          MATTERMOST_TITLE: 'Reference: ${{ github.ref }}'\n          MATTERMOST_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: mattermost\n```\n\n## Twillio\n\n```yaml\non:\n  release:\n    types: [published]\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          TWILLIO_TOKEN: ${{ secrets.TWILLIO_TOKEN }}\n          TWILLIO_ACCOUNT_SID: ${{ secrets.TWILLIO_ACCOUNT_SID }}\n          TWILLIO_SENDER: ${{ secrets.TWILLIO_SENDER }}\n          TWILLIO_RECEIVER: ${{ secrets.TWILLIO_RECEIVER }}\n          TWILLIO_TITLE: 'Reference: ${{ github.ref }}'\n          TWILLIO_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: twillio\n```\n\n## Gotify\n\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          GOTIFY_TOKEN: ${{ secrets.GOTIFY_TOKEN }}\n          GOTIFY_URL: 'example.com'\n          GOTIFY_TITLE: 'Reference: ${{ github.ref }}'\n          GOTIFY_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        \n        with:\n          # Chose the messaging platform. \n          # slack / telegram / rocketchat / teams / pushover / discord / email\n          service: gotify\n```\n\n## Line\n\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          LINE_SECRET: ${{ secrets.LINE_SECRET }}\n          LINE_TOKEN: ${{ secrets.LINE_TOKEN }}\n          LINE_RECEIVER_IDS: 'ab1235xxx8'\n          LINE_MSG_TITLE: 'Reference: ${{ github.ref }}'\n          LINE_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: line\n```\n\n## Mattermost\n\n```yaml\non:\n  release:\n    types: [published]\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n      \n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          MATTERMOST_TOKEN: ${{ secrets.MATTERMOST_TOKEN }}\n          MATTERMOST_SERVER_URL: ${{ secrets.MATTERMOST_SERVER_URL }}\n          MATTERMOST_CHANNELS: ${{ secrets.MATTERMOST_CHANNELS }}\n          MATTERMOST_TITLE: 'Reference: ${{ github.ref }}'\n          MATTERMOST_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: mattermost\n```\n\n## Mastodon\n\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          MASTODON_TOKEN: ${{ secrets.MASTODON_TOKEN }}\n          MASTODON_SERVER: 'mastodon.social'\n          MASTODON_TITLE: 'Reference: ${{ github.ref }}'\n          MASTODON_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        \n        with:\n          service: mastodon\n```\n\n## Textmagic\n\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          TEXTMAGIC_USER: ${{ secrets.TEXTMAGIC_USER }}\n          TEXTMAGIC_TOKEN: ${{ secrets.TEXTMAGIC_TOKEN }}\n          TEXTMAGIC_TITLE: 'Reference: ${{ github.ref }}'\n          TEXTMAGIC_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n          TEXTMAGIC_RECEIVER:  ${{ secrets.TEXTMAGIC_RECEIVER }}\n        with:\n          service: textmagic\n```\n\n## WeChat\n\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          WECHAT_APPID: ${{ secrets.WECHAT_APPID }}\n          WECHAT_APPSECRET: ${{ secrets.WECHAT_APPSECRET }}\n          WECHAT_TOKEN: ${{ secrets.WECHAT_TOKEN }}\n          WECHAT_ENCODINGAESKEY: ${{ secrets.WECHAT_ENCODINGAESKEY }}\n          WECHAT_RECEIVER_IDS: ${{ secrets.WECHAT_RECEIVER_IDS }}\n          WECHAT_MSG_TITLE: 'Reference: ${{ github.ref }}'\n          WECHAT_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        \n        with:\n          service: wechat\n\n```\n\n## Zulip\n\n```yaml\non: [push]\n\njobs:\n  pingme-job:\n    runs-on: ubuntu-latest\n    name: PingMe\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Ping me On\n        uses: kha7iq/pingme-action@v1\n        env:\n          ZULIP_DOMAIN: ${{ secrets.ZULIP_DOMAIN }}\n          ZULIP_BOT_EMAIL_ADDRESS: ${{ secrets.ZULIP_BOT_EMAIL_ADDRESS }}\n          ZULIP_BOT_API_KEY: ${{ secrets.ZULIP_BOT_API_KEY }}\n          ZULIP_MSG_TYPE: 'stream'\n          ZULIP_STREAM_NAME: 'general'\n          ZULIP_TOPIC: 'Reference: ${{ github.ref }}'\n          ZULIP_MESSAGE: 'Event is triggered by ${{ github.event_name }}'\n        with:\n          service: zulip\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkha7iq%2Fpingme-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkha7iq%2Fpingme-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkha7iq%2Fpingme-action/lists"}