{"id":20490777,"url":"https://github.com/circleci-public/slack-orb","last_synced_at":"2025-04-09T05:10:09.898Z","repository":{"id":34023322,"uuid":"153695220","full_name":"CircleCI-Public/slack-orb","owner":"CircleCI-Public","description":"Create custom Slack notifications for CircleCI job statuses","archived":false,"fork":false,"pushed_at":"2024-09-17T18:38:17.000Z","size":690,"stargazers_count":214,"open_issues_count":13,"forks_count":206,"subscribers_count":15,"default_branch":"main","last_synced_at":"2024-09-17T22:50:11.129Z","etag":null,"topics":["circleci-orb","circleci-orbs","hacktoberfest","slack","slack-notifications"],"latest_commit_sha":null,"homepage":"https://circleci.com/developer/orbs/orb/circleci/slack","language":"Shell","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/CircleCI-Public.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-18T22:29:20.000Z","updated_at":"2024-09-17T18:34:04.000Z","dependencies_parsed_at":"2024-01-24T19:38:44.768Z","dependency_job_id":"919a41e2-dd8e-47df-985f-1717bf8c3aee","html_url":"https://github.com/CircleCI-Public/slack-orb","commit_stats":null,"previous_names":[],"tags_count":56,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fslack-orb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fslack-orb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fslack-orb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fslack-orb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CircleCI-Public","download_url":"https://codeload.github.com/CircleCI-Public/slack-orb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980837,"owners_count":21027808,"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":["circleci-orb","circleci-orbs","hacktoberfest","slack","slack-notifications"],"created_at":"2024-11-15T17:18:27.212Z","updated_at":"2025-04-09T05:10:09.880Z","avatar_url":"https://github.com/CircleCI-Public.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Slack Orb  [![CircleCI Build Status](https://circleci.com/gh/CircleCI-Public/slack-orb.svg?style=shield \"CircleCI Build Status\")](https://circleci.com/gh/CircleCI-Public/slack-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/circleci/slack.svg)](https://circleci.com/orbs/registry/orb/circleci/slack) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/circleci-public/slack-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)\n\nSend Slack notifications from your CircleCI pipelines even easier with Slack Orb 4.0\n\n[What are Orbs?](https://circleci.com/orbs/)\n\n## Usage\n\n### Setup\n\nIn order to use the Slack Orb on CircleCI you will need to create a Slack App and provide an OAuth token. Find the guide in the wiki: [How to setup Slack orb](https://github.com/CircleCI-Public/slack-orb/wiki/Setup)\n\n### Use In Config\n\nFor full usage guidelines, see the [Orb Registry listing](http://circleci.com/orbs/registry/orb/circleci/slack).\n\n## Templates\n\nThe Slack Orb comes with a number of included templates to get your started with minimal setup. Feel free to use an included template or create your own.\n\n| Template Preview  | Template  | Description |\n| ------------- | ------------- | ------------- |\n| ![basic_success_1](./.github/img/basic_success_1.png)  | basic_success_1   | Should be used with the \"pass\" event. |\n| ![basic_fail_1](./.github/img/basic_fail_1.png)  | basic_fail_1   | Should be used with the \"fail\" event. |\n| ![success_tagged_deploy_1](./.github/img/success_tagged_deploy_1.png)  | success_tagged_deploy_1   | To be used in the event of a successful deployment job. _see orb [usage examples](https://circleci.com/developer/orbs/orb/circleci/slack#usage-examples)_ |\n| ![basic_on_hold_1](./.github/img/basic_on_hold_1.png)  | basic_on_hold_1   | To be used in the on-hold job. _see orb [usage examples](https://circleci.com/developer/orbs/orb/circleci/slack#usage-examples)_  |\n\n\n## Custom Message Template\n\n  1. Open the Slack Block Kit Builder: https://app.slack.com/block-kit-builder/\n  2. Design your desired notification message.\n  3. Replace any placeholder values with $ENV environment variable strings.\n  4. Set the resulting code as the value for your `custom` parameter.\n\n  ```yaml\n- slack/notify:\n      event: always\n      custom: |\n        {\n          \"blocks\": [\n            {\n              \"type\": \"section\",\n              \"fields\": [\n                {\n                  \"type\": \"plain_text\",\n                  \"text\": \"*This is a text notification*\",\n                  \"emoji\": true\n                }\n              ]\n            }\n          ]\n        }\n  ```\n\n## Branch or Tag Filtering\n\nLimit Slack notifications to particular branches with the \"branch_pattern\" or \"tag_pattern\" parameter.\n\nA comma separated list of regex matchable branch or tag names. Notifications will only be sent if sent from a job from these branches/tags. Pattern must match the full string, no partial matches. Keep in mind that \"branch_pattern\" and \"tag_pattern\" are mutually exclusive.\n\nSee [usage examples](https://circleci.com/developer/orbs/orb/circleci/slack#usage-examples).\n\n## Thread Messages\n\nPost replies in threads with a special parameter `thread_id`. Including this parameter in the `notify` command reference stores the id of the message in a small portion of bytes in cache. Any subsequent invocation of the command with the same value for `thread_id` will post a reply to the initial message in a thread. Example:\n\n```yaml\n- slack/notify:\n      event: always\n      channel: engineering\n      thread_id: testing\n      custom: |\n        {\n          \"blocks\": [\n            {\n              \"type\": \"section\",\n              \"fields\": [\n                {\n                  \"type\": \"plain_text\",\n                  \"text\": \"*Tests started.*\",\n                  \"emoji\": true\n                }\n              ]\n            }\n          ]\n        }\n- slack/notify:\n      event: always\n      channel: engineering\n      thread_id: testing\n      custom: |\n        {\n          \"blocks\": [\n            {\n              \"type\": \"section\",\n              \"fields\": [\n                {\n                  \"type\": \"plain_text\",\n                  \"text\": \"*Tests finished.*\",\n                  \"emoji\": true\n                }\n              ]\n            }\n          ]\n        }\n```\n\n## Scheduled Message\n\nSet the `scheduled_offset_seconds` special parameter to a number of seconds if you want to post a scheduled message. Example:\n\n  ```yaml\n- slack/notify:\n      event: always\n      scheduled_offset_seconds: 30\n      custom: |\n        {\n          \"blocks\": [\n            {\n              \"type\": \"section\",\n              \"fields\": [\n                {\n                  \"type\": \"plain_text\",\n                  \"text\": \"*This is a text notification*\",\n                  \"emoji\": true\n                }\n              ]\n            }\n          ]\n        }\n  ```\n\n\n---\n\n## FAQ\n\nView the [FAQ in the wiki](https://github.com/CircleCI-Public/slack-orb/wiki/FAQ)\n\n## Contributing\n\nWe welcome [issues](https://github.com/CircleCI-Public/slack-orb/issues) to and [pull requests](https://github.com/CircleCI-Public/slack-orb/pulls) against this repository!\n\nFor further questions/comments about this or other orbs, visit [CircleCI's orbs discussion forum](https://discuss.circleci.com/c/orbs).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-public%2Fslack-orb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcircleci-public%2Fslack-orb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-public%2Fslack-orb/lists"}