You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: jekyll/_cci2/notifications.md
+67Lines changed: 67 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,10 @@ order: 100
7
7
published: true
8
8
---
9
9
10
+
* TOC
11
+
{:toc}
12
+
13
+
10
14
CircleCI has integrated chat notifications, automated email notifications, and
11
15
web notifications. Slack and Email notifications are delivered on the success or failure of a
12
16
[workflow]({{ site.baseurl }}/2.0/workflows/). IRC notifications are
@@ -80,3 +84,66 @@ request permission in this case. Use your browser settings to control notificati
80
84
81
85
While the process is similar for other browsers, please refer to their individual
82
86
documentation for handling web notifications.
87
+
88
+
## Notifications with Orbs
89
+
90
+
You can use Orbs to integrate various kinds of notifications into your configuration; currently, CircleCI offers a Slack orb and an IRC orb, but several third-party orbs also exist. Consider searching the [orb registry](https://circleci.com/orbs/registry/?query=notification&filterBy=all) for _notifications_ to see what is available.
91
+
92
+
### Prerequisites
93
+
94
+
Before integrating an orb into your configuration, you will need to perform two steps: increment the `version` key in your config to `2.1` and enable `pipelines` under `Project Settings` > `Advanced Settings` in the CircleCI web application.
95
+
96
+
### Using the Slack Orb
97
+
98
+
Using the [CircleCI Slack Orb](https://circleci.com/orbs/registry/orb/circleci/slack), you can integrate and customize Slack notifications directly from your configuration file. The following config is an example of notifying a Slack channel with a custom message:
It is also possible to use the Slack Orb to provide other types of notifications, including notifying a slack channel of a pending approval or sending a status alert at the end of a job based on success or failure. To view such usage examples, consult the [CircleCI Slack Orb page](https://circleci.com/orbs/registry/orb/circleci/slack).
122
+
123
+
### Using the IRC Orb
124
+
125
+
The [IRC orb](https://circleci.com/orbs/registry/orb/circleci/irc) is similar to the Slack orb, but only has one main feature: sending custom IRC notifications from CircleCI. Consider this example configuration:
0 commit comments