{"id":24515586,"url":"https://github.com/magicbell/action","last_synced_at":"2026-04-25T18:32:47.479Z","repository":{"id":103513645,"uuid":"575906557","full_name":"magicbell/action","owner":"magicbell","description":"Github action for sending multi-channel notifications to an Inbox, email, or Slack using MagicBell","archived":false,"fork":false,"pushed_at":"2024-06-27T14:52:49.000Z","size":152,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-10T07:01:59.519Z","etag":null,"topics":["actions","github-actions","magicbell","notifications","slack-bot"],"latest_commit_sha":null,"homepage":"https://www.magicbell.com","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/magicbell.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":"2022-12-08T15:09:12.000Z","updated_at":"2024-06-27T14:52:53.000Z","dependencies_parsed_at":"2024-06-27T17:55:31.238Z","dependency_job_id":null,"html_url":"https://github.com/magicbell/action","commit_stats":null,"previous_names":["magicbell/action"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicbell%2Faction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicbell%2Faction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicbell%2Faction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicbell%2Faction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magicbell","download_url":"https://codeload.github.com/magicbell/action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243719373,"owners_count":20336596,"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":["actions","github-actions","magicbell","notifications","slack-bot"],"created_at":"2025-01-22T01:18:29.507Z","updated_at":"2026-04-25T18:32:47.472Z","avatar_url":"https://github.com/magicbell.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Send notifications from your GitHub workflows\n\nUse this GitHub action to inform yourself or your team about activity in your repository. Think of use cases like:\n\n- sending your team a notification when an issue is labelled `critical`\n- sending devops a notification when a deployment fails\n- sending yourself a notification when a new pull request is opened\n- sending the contributor a notification when their pull request is merged\n- sending a Slack message to your announcements channel on a new release\n\n[MagicBell](https://www.magicbell.com) also offers a [GitHub Workflow Builder](https://www.magicbell.com/workflows/github) that let's you listen to webhook events and trigger notifications!\n\n## Usage\n\n```yaml\nname: 'Notify Me'\non: pull_request\n\njobs:\n  notify:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Send Notification\n        uses: magicbell/action/notify@v1\n        with:\n          api-key: ${{ secrets.MAGICBELL_API_KEY }}\n          api-secret: ${{ secrets.MAGICBELL_API_SECRET }} \n          recipients: 'person@example.com, bot@example.com'\n          title: 'Activity on pull ${{ github.event.number }}!'\n```\n\n## Inputs\n\nThe `notify` action accepts a number of options. The following options are required for all calls:\n\n- **api-key** _String_\n  \n  Your project api key which can be found on the MagicBell Dashboard. This key is required for all calls.\n\n- **api-secret** _String_\n\n  Your project api secret which can be found on the MagicBell Dashboard. This key is required for project oriented endpoints.\n\n- **title** _String_\n\n  The title of the notification.\n\n- **recipients** _String_\n\n  A comma (`,`) separated list of recipients, currently limited to email addresses.\n\nThe following options are optional:\n\n\n- **content** _String_\n\n  The content of the notification.\n\n- **category** _String_\n \n  The category of the notification. This can be used to group notifications together.\n\n- **topic** _String_\n\n  The topic of the notification. This can be used to thread notifications.\n\n- **action-url** _String_\n\n  The URL to which the notification will link to.\n\n- **custom-attributes** _JSON_\n\n  A JSON string of custom attributes to be attached to the notification. Tip; use the GitHub `${{ toJson(...) }}` helper.\n\n- **overrides** _JSON_\n\n  A JSON string of delivery overrides to be attached to the notification. Tip; use the GitHub `${{ toJson(...) }}` helper.\n\n## Recipes\n\n### Sending the contributor a notification on push\n\n```yaml\nname: 'Notify Contributor'\n\non: push\n\njobs:\n  notify:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Send Notification\n        uses: magicbell/action/notify@v1\n        with: # api-key, api-secret, recipients and title are required.\n          api-key: ${{ secrets.MAGICBELL_API_KEY }}\n          api-secret: ${{ secrets.MAGICBELL_API_SECRET }}\n          recipients: '${{ github.event.pusher.email }}'\n          title: 'Thanks for pushing!'\n```\n\n### Sending a notification on pull request activity\n\n```yaml\nname: 'Notify on pull request'\n\non: pull_request\n\njobs:\n  notify:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Send Notification\n        uses: magicbell/action/notify@v1\n        with: # api-key, api-secret, recipients and title are required.\n          api-key: ${{ secrets.MAGICBELL_API_KEY }}\n          api-secret: ${{ secrets.MAGICBELL_API_SECRET }} \n          recipients: '${{ secrets.MY_EMAIL }}'\n          title: 'Activity on pull ${{ github.event.number }}!'\n          action-url: 'https://github.com/${{ github.repository }}/pulls/${{ github.event.number }}'\n```\n\n### Sending a notification when publishing a release\n\n```yaml\nname: On Release\n\non:\n  release:\n    types: [published]\n\njobs:\n  notify:\n    name: Send Release Notes\n    runs-on: ubuntu-latest\n\n    steps:\n      - name: Send Notification\n        uses: magicbell/action/notify@v1\n        with:\n          api-key: ${{ secrets.MAGICBELL_API_KEY }}\n          api-secret: ${{ secrets.MAGICBELL_API_SECRET }}\n          recipients: ${{ secrets.MY_EMAIL }}\n          title: 'Just Released: ${{ github.event.release.name }}!'\n          content: ${{ github.event.release.body }}\n          action-url: ${{ github.event.release.html_url }}\n```\n\n### Sending a notification when an issue gets created\n\n```yaml\nname: On Issue Created\n\non:\n  issues:\n    types: [opened]\n\njobs:\n  notify-me:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Send Notification\n        uses: magicbell/action/notify@main\n        with:\n          api-key: ${{ secrets.MAGICBELL_API_KEY }}\n          api-secret: ${{ secrets.MAGICBELL_API_SECRET }}\n          recipients: '${{ secrets.MY_EMAIL }}'\n          title: 'Issue created: ${{ github.event.issue.number }} - ${{ github.event.issue.title }}'\n          content: ${{ github.event.issue.body }}\n          action-url: ${{ github.event.issue.html_url }}\n          custom-attributes: ${{ toJSON(github.event.issue) }}\n```\n\n### Sending a notification when an issue gets labelled\n\n```yaml\nname: On Issue Labeled Critical\n\non:\n  issues:\n    types: [labeled]\n\njobs:\n  notify:\n    if: github.event.label.name == 'critical'\n    runs-on: ubuntu-latest\n    \n    steps:\n      - name: Send Notification\n        uses: magicbell/action/notify@v1\n        with:\n          api-key: ${{ secrets.MAGICBELL_API_KEY }}\n          api-secret: ${{ secrets.MAGICBELL_API_SECRET }}\n          recipients: ${{ secrets.MY_EMAIL }}\n          title: 'Issue declared critical: ${{ github.event.issue.number }} - ${{ github.event.issue.title }}'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicbell%2Faction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagicbell%2Faction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicbell%2Faction/lists"}