-
Notifications
You must be signed in to change notification settings - Fork 3
docs: Custom webhook notifier #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bhushan-nemade-dt
wants to merge
5
commits into
devtron-labs:main
Choose a base branch
from
bhushan-nemade-dt:custom-webhook-notifier
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Custom Webhook Notifier | ||
|
||
## Introduction | ||
The Custom Webhook Notifier plugin by Devtron allows users to set up automated webhook notifications that integrate with various third-party services in their Job pipelines and at pre/post stages of Devtron CI/CD workflows. Teams can seamlessly integrate this plugin to keep external services and team members updated about pipeline events and status changes. Some key use cases of this plugin can be: | ||
- Configuring notifications at pre/post stages to update teams on task completion status, such as sending vulnerability scanning reports. | ||
- Setting up automated alerts at the runbooks of auto-remediation using jobs. | ||
|
||
{% hint style="warning" %} | ||
If you wish to get notifications at Trigger, Success, and Failure events of CI/CD pipelines, use Devtron's native [Notifications](https://docs.devtron.ai/global-configurations/manage-notification). | ||
{% endhint %} | ||
|
||
### Prerequisites | ||
Before integrating the **Custom Webhook Notifier** plugin, you must ensure that you have properly configured weebhook notifications in your Devtron setup. | ||
|
||
--- | ||
|
||
## Steps | ||
|
||
{% hint style="warning" %} | ||
If you want to integrate the **Custom Webhook Notifier** at the job, navigate to the **[Custom Email Notifier](https://docs.devtron.ai/usage/plugins/plugin-list/custom-email-notifier)** plugin and follow the steps mentioned. | ||
{% endhint %} | ||
|
||
1. Go to **Applications** → **Devtron Apps**. | ||
bhushan-nemade-dt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
2. Click your application. | ||
3. Go to **App Configuration** → **Workflow Editor**. | ||
4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. | ||
5. Fill the required fields in the **Create build pipeline** window and navigate to the **Post-build stage**. | ||
|
||
{% hint style="warning" %} | ||
If you have already configured workflow, edit the build pipeline, and navigate to **Post-build stage**. | ||
{% endhint %} | ||
|
||
6. Under 'TASKS', click the **+ Add task** button. | ||
7. Click the **Custom Webhook Notifier** plugin. | ||
8. Enter the following [user inputs](#user-inputs) with appropriate values. | ||
|
||
--- | ||
|
||
## User Inputs | ||
|
||
### Task Name | ||
Enter the name of your task | ||
|
||
e.g., `Webhook Notifier` | ||
|
||
### Description | ||
Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task. | ||
|
||
e.g., `The Custom Webhook Notifier plugin is integrated for sending an automated email notifications to relevant stakeholders.` | ||
bhushan-nemade-dt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Input Variables | ||
| Variable | Format | Description | Sample Value | | ||
| ------------------------ | ------------ | ----------- | ------------ | | ||
| CONFIG_TYPE | STRING | Type of notification configuration. SES or SMTP | SES | | ||
| CONFIG_NAME | STRING | Name of the notification configuration to be used. This should match an existing notification configuration in Devtron. | vulnerability-scan report | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What will be the payload of this notification? |
||
|
||
### Trigger/Skip Condition | ||
Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task. | ||
|
||
### Output Variables | ||
Custom Webhook Notifier will not be generating an output variable. | ||
|
||
Click **Update Pipeline**. | ||
|
||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.