https://github.com/tickup-se/notify_opsgenie
github action sending alerts to opsgenie
https://github.com/tickup-se/notify_opsgenie
actions github-actions opsgenie opsgenie-api
Last synced: 9 days ago
JSON representation
github action sending alerts to opsgenie
- Host: GitHub
- URL: https://github.com/tickup-se/notify_opsgenie
- Owner: tickup-se
- Created: 2022-10-27T12:28:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-12-05T02:32:11.000Z (7 months ago)
- Last Synced: 2026-06-04T09:58:01.452Z (15 days ago)
- Topics: actions, github-actions, opsgenie, opsgenie-api
- Language: Go
- Homepage:
- Size: 568 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Send incident to OpsGenie
GitHub action sending custom incidents to opsgenie.
For the action to integrate with your OpsGenie installation you need an API key. The API key may be obtained from the organisations OpsGenie frontpage under **Settings** (upper right) -> **APP SETTINGS** (section to the left) -> **API key management**. The API key management requires a privileged account.
You also need a configured **team** as a recipient of the incidents. If you misconfigure this part the incident will be sent to your OpsGenie system and this script will report success, however since there are no matching recipients on the other end no one will get notified.
## Parameters
**MESSAGE** (optional)
Main message. If not provided a generic message will be provided stating the repository generating the alert.
**DESCRIPTION** (optional)
Will be part of the description section of the incident. The description already contains the short SHA and workflow name.
**PRIORITY** (required)
The priority level of your incident (P1 -> P5)
**API_KEY** (required)
Your OpsGenie secret API key. Use the repository or organization secrets as your key storage.
**TEAM** (required)
The team to address this incident to
**TAG** (optional)
Custom tag
## Prefilled information
The incident report alreday contains decorated information consiting of:
**Title:**
The repository name (override by providing **MESSAGE**)
**Decription:**
Workflow name
Short SHA (7 characters)
**Details:**
Runner OS
Runner Arch
Branch
## Usage
Sending incidents to OpsGenie may be triggered by just failing actions or by advanced expressions. GitHub has put together a great guide:
[GitHub action expressions](https://docs.github.com/en/actions/learn-github-actions/expressions)
#### Example Usage:
*Minimal:*
```yaml
- name: Send OpsGenie incident
if: success()
uses: tickup-se/notify_opsgenie@v2
with:
API_KEY: ${{ secrets.OPS_GENIE }}
PRIORITY: 'P5'
TEAM: 'existing team name'
```
*All parameters:*
```yaml
- name: Send OpsGenie incident
if: success()
uses: tickup-se/notify_opsgenie@v2
with:
MESSAGE: 'some message'
DESCRIPTION: 'some description'
API_KEY: ${{ secrets.OPS_GENIE }}
PRIORITY: 'P5'
TEAM: 'existing team name'
TAG: 'some tag'
```
# Incident example on an iPhone
