Configuring notifications
PipeCD events (deployment triggered, planned, completed, analysis result, piped started…) can be sent to external services like Slack or a Webhook service. While forwarding those events to a chat service helps developers have a quick and convenient way to know the deployment’s current status, forwarding to a Webhook service may be useful for triggering other related tasks like CI jobs.
PipeCD events are emitted and sent by the piped component. So all the needed configurations can be specified in the piped configuration file.
Notification configuration including:
- a list of
Routes which used to match events and decide where the event should be sent to - a list of
Receivers which used to know how to send events to the external service
Notification Route matches events based on their metadata like name, group, app, labels.
Below is the list of supporting event names and their groups.
| Event | Group | Supported | Description |
|---|---|---|---|
| DEPLOYMENT_TRIGGERED | DEPLOYMENT | ||
| DEPLOYMENT_PLANNED | DEPLOYMENT | ||
| DEPLOYMENT_APPROVED | DEPLOYMENT | ||
| DEPLOYMENT_WAIT_APPROVAL | DEPLOYMENT | ||
| DEPLOYMENT_ROLLING_BACK | DEPLOYMENT | ||
| DEPLOYMENT_SUCCEEDED | DEPLOYMENT | ||
| DEPLOYMENT_FAILED | DEPLOYMENT | ||
| DEPLOYMENT_CANCELLED | DEPLOYMENT | ||
| DEPLOYMENT_TRIGGER_FAILED | DEPLOYMENT | ||
| APPLICATION_SYNCED | APPLICATION_SYNC | ||
| APPLICATION_OUT_OF_SYNC | APPLICATION_SYNC | ||
| APPLICATION_HEALTHY | APPLICATION_HEALTH | ||
| APPLICATION_UNHEALTHY | APPLICATION_HEALTH | ||
| PIPED_STARTED | PIPED | ||
| PIPED_STOPPED | PIPED |
Sending notifications to Slack
apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
notifications:
routes:
# Sending all event which contains labels `env: dev` to dev-slack-channel.
- name: dev-slack
labels:
env: dev
receiver: dev-slack-channel
# Only sending deployment started and completed events which contains
# labels `env: prod` and `team: pipecd` to prod-slack-channel.
- name: prod-slack
events:
- DEPLOYMENT_TRIGGERED
- DEPLOYMENT_SUCCEEDED
labels:
env: prod
team: pipecd
receiver: prod-slack-channel
- name: integration-slack
receiver: integration-slack-api
receivers:
- name: dev-slack-channel
slack:
hookURL: https://slack.com/dev
- name: prod-slack-channel
slack:
hookURL: https://slack.com/prod
- name: integration-slack-api
slack:
oauthTokenData: "token"
channelID: "testid"
- name: hookurl-with-mentioned-accounts
slack:
hookURL: https://slack.com/dev,
mentionedAccounts:
- '@user1'
- 'user2'
- name: integration-slack-api-with-mentioned-accounts
slack:
oauthTokenData: token
channelID: testid
mentionedAccounts:
- '@user1'
- 'user2'
Deployment was triggered, planned and completed successfully
A piped has been started
For detailed configuration, please check the configuration reference for Notifications section.
Sending notifications to external services via webhook
apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
notifications:
routes:
# Sending all events an external service.
- name: all-events-to-a-external-service
receiver: a-webhook-service
receivers:
- name: a-webhook-service
webhook:
url: {WEBHOOK_SERVICE_URL}
signatureValue: {RANDOM_SIGNATURE_STRING}
For detailed configuration, please check the configuration reference for NotificationReceiverWebhook section.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.
