Ops Genie Alert API

OpsGenie Alert API connector uses OpsGenie Alert REST API. Opsgenie is a modern incident management platform that helps organizations quickly detect and respond to incidents.

Prerequisites

OpsGenie Alert API requires an apiKey

Asset Setup

The asset for this plugin requires the following inputs:

API Token

Capabilities

OpsGenie Alert API connector has the following capabilities.

Get Request Status

Create Alert

Delete Alert

Get Alert

List Alerts

Count Alerts

Acknowledge Alert

Close Alert

Add Note to Alert

Execute Custom Action

Unacknowledge Alert

Snooze Alert

Escalate Alert to Next

Assign Alert

Add Team to Alert ... and so on

Notes

The complete documentation for the API is found at: https://docs.opsgenie.com/docs/alert-api

apiKey can be created at https://app.opsgenie.com/

Additional Documentation

Ops Genie Alert API Connector Documentation

Ops Genie Alert API API Documentation

Ops Genie Alert API Authentication Guide

Configurations

API Key Authentication

Authenticates using an API Key

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
x-apikey	GenieKey	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Acknowledge Alert

OpsGenie acknowledge alert

Endpoint

URL: v2/alerts/{{identifier}}/acknowledge

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Identifier of the alert
parameters.identifierType	string	Optional	Parameters for the Acknowledge Alert action
source	string	Optional	Source field of the alert. Default value is IP address of the incoming request
note	string	Optional	Additional note that will be added while creating the alert
user	string	Optional	Display name of the request owner

Input Example

{"path_parameters":{"identifier":"string"},"parameters":{"identifierType":"string"},"source":"string","note":"string","user":"string"}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Add Note To Alert

OpsGenie add note to alert

Endpoint

URL: v2/alerts/{{identifier}}/notes

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Add Note To Alert action
parameters.identifierType	string	Optional	Parameters for the Add Note To Alert action
user	string	Optional	Parameter for Add Note To Alert
source	string	Optional	Parameter for Add Note To Alert
note	string	Optional	Parameter for Add Note To Alert

Input Example

{"parameters":{"identifierType":"id"},"json_body":{"user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Add Responder to Alert

OpsGenie add responder to alert

Endpoint

URL: v2/alerts/{{identifier}}/responders

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Add Responder to Alert action
parameters.identifierType	string	Optional	Parameters for the Add Responder to Alert action
responder	object	Optional	Parameter for Add Responder to Alert
responder.type	string	Optional	Type of the resource
responder.id	string	Optional	Unique identifier
user	string	Optional	Parameter for Add Responder to Alert
source	string	Optional	Parameter for Add Responder to Alert
note	string	Optional	Parameter for Add Responder to Alert

Input Example

{"parameters":{"identifierType":"id"},"json_body":{"responder":{"type":"team","id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c"},"user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Add Tags to Alert

OpsGenie add tags to alert

Endpoint

URL: v2/alerts/{{identifier}}/tags

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Add Tags to Alert action
parameters.identifierType	string	Optional	Parameters for the Add Tags to Alert action
tags	array	Optional	Parameter for Add Tags to Alert
user	string	Optional	Parameter for Add Tags to Alert
source	string	Optional	Parameter for Add Tags to Alert
note	string	Optional	Parameter for Add Tags to Alert

Input Example

{"parameters":{"identifierType":"id"},"json_body":{"tags":["OverwriteQuietHours","Critical"],"user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Add Team to Alert

OpsGenie add team to alert

Endpoint

URL: v2/alerts/{{identifier}}/teams

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Add Team to Alert action
parameters.identifierType	string	Optional	Parameters for the Add Team to Alert action
team	object	Optional	Parameter for Add Team to Alert
team.id	string	Optional	Unique identifier
user	string	Optional	Parameter for Add Team to Alert
source	string	Optional	Parameter for Add Team to Alert
note	string	Optional	Parameter for Add Team to Alert

Input Example

{"parameters":{"identifierType":"id"},"json_body":{"team":{"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c"},"user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Assign Alert

OpsGenie assign alert

Endpoint

URL: v2/alerts/{{identifier}}/assign

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Assign Alert action
parameters.identifierType	string	Optional	Parameters for the Assign Alert action
owner	object	Optional	Parameter for Assign Alert
owner.id	string	Optional	Unique identifier
user	string	Optional	Parameter for Assign Alert
source	string	Optional	Parameter for Assign Alert
note	string	Optional	Parameter for Assign Alert

Input Example

{"parameters":{"identifierType":"id"},"json_body":{"owner":{"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c"},"user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Close Alert

OpsGenie close alert

Endpoint

URL: v2/alerts/{{identifier}}/close

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Close Alert action
parameters.identifierType	string	Optional	Parameters for the Close Alert action
user	string	Optional	Parameter for Close Alert
source	string	Optional	Parameter for Close Alert
note	string	Optional	Parameter for Close Alert

Input Example

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Count Alerts

Count alerts request is used to count alerts in Opsgenie

Endpoint

URL: v2/alerts/count

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Optional	Search query to apply while filtering the alerts
parameters.searchIdentifier	string	Optional	Identifier of the saved search query to apply while filtering the alerts
parameters.searchIdentifierType	string	Optional	Identifier type of the saved search query. Possible values are id and name. Default value is id.

Input Example

{"parameters":{"query":"string","searchIdentifier":"string","searchIdentifierType":"string"}}

Output

Parameter	Type	Description
data	object	Response data
data.count	number	Response data
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"data":{"count":7},"took":0.051,"requestId":"9ae63dd7-ed00-4c81-86f0-c4ffd33142c9"}

Create Alert

Create Alert using OpsGenie Rest API

Endpoint

URL: v2/alerts

Method: POST

Input

Argument Name	Type	Required	Description
message	string	Optional	Message of the alert
alias	string	Optional	Client-defined identifier of the alert.
description	string	Optional	a detailed information about the alert
responders	array	Optional	Teams, users, escalations and schedules that the alert will be routed to send notifications
responders.id	string	Optional	Unique identifier
responders.type	string	Optional	Type of the resource
responders.name	string	Optional	Name of the resource
responders.username	string	Optional	Name of the resource
visibleTo	array	Optional	Teams and users that the alert will become visible to without sending any notification
visibleTo.id	string	Optional	Unique identifier
visibleTo.type	string	Optional	Type of the resource
visibleTo.name	string	Optional	Name of the resource
visibleTo.username	string	Optional	Name of the resource
actions	array	Optional	Custom actions that will be available for the alert
tags	array	Optional	Tags of the alert
details	object	Optional	Map of key-value pairs to use as custom properties of the alert
details.key1	string	Optional	Parameter for Create Alert
details.key2	string	Optional	Parameter for Create Alert
entity	string	Optional	used to specify which domain alert is related to
priority	string	Optional	Priority level of the alert. Possible values are P1, P2, P3, P4 and P5. Default value is P3
source	string	Optional	Source field of the alert. Default value is IP address of the incoming request
note	string	Optional	Additional note that will be added while creating the alert
user	string	Optional	Display name of the request owner

Input Example

{"message":"string","alias":"string","description":"string","responders":[{"id":"12345678-1234-1234-1234-123456789abc","type":"string","name":"Example Name","username":"Example Name"}],"visibleTo":[{"id":"12345678-1234-1234-1234-123456789abc","type":"string","name":"Example Name","username":"Example Name"}],"actions":["string"],"tags":["string"],"details":{"key1":"string","key2":"string"},"entity":"string","priority":"string","source":"string","note":"string","user":"string"}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Delete Alert

OpsGenie delete alert

Endpoint

URL: v2/alerts/{{identifier}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Identifier of the alert
parameters.identifierType	string	Optional	Possible values are AlertID and tinyID.
parameters.user	string	Optional	Display name of the request owner.
parameters.source	string	Optional	Display name of the request source

Input Example

{"path_parameters":{"identifier":"string"},"parameters":{"identifierType":"string","user":"string","source":"string"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Escalate Alert to Next

OpsGenie escalate alert to next

Endpoint

URL: v2/alerts/{{identifier}}/escalate

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Escalate Alert to Next action
parameters.identifierType	string	Optional	Parameters for the Escalate Alert to Next action
escalation	object	Optional	Escalation that the alert will be escalated. Either id or name of the escalation should be provided.
escalation.id	string	Optional	Unique identifier
user	string	Optional	Parameter for Escalate Alert to Next
source	string	Optional	Parameter for Escalate Alert to Next
note	string	Optional	Parameter for Escalate Alert to Next

Input Example

{"parameters":{"identifierType":"id"},"json_body":{"escalation":{"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c"},"user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Execute Custom Action

OpsGenie execute custom action

Endpoint

URL: v2/alerts/{{identifier}}/actions/{{action}}

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Execute Custom Action action
path_parameters.action	string	Required	Parameters for the Execute Custom Action action
parameters.identifierType	string	Optional	Parameters for the Execute Custom Action action
user	string	Optional	Parameter for Execute Custom Action
source	string	Optional	Parameter for Execute Custom Action
note	string	Optional	Parameter for Execute Custom Action

Input Example

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Get Alert

OpsGenie get alert

Endpoint

URL: v2/alerts/{{identifier}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Identifier of the alert
parameters.identifierType	string	Optional	Parameters for the Get Alert action

Input Example

{"path_parameters":{"identifier":"string"},"parameters":{"identifierType":"string"}}

Output

Parameter	Type	Description
data	object	Response data
data.id	string	Response data
data.tinyId	string	Response data
data.alias	string	Response data
data.message	string	Response data
data.status	string	Response data
data.acknowledged	boolean	Response data
data.isSeen	boolean	Response data
data.tags	array	Response data
data.snoozed	boolean	Response data
data.snoozedUntil	string	Response data
data.count	number	Response data
data.lastOccurredAt	string	Response data
data.createdAt	string	Response data
data.updatedAt	string	Response data
data.source	string	Response data
data.owner	string	Response data
data.priority	string	Response data
data.responders	array	Response data
data.responders.id	string	Response data
data.responders.type	string	Response data
data.integration	object	Response data
data.integration.id	string	Response data
data.integration.name	string	Response data
data.integration.type	string	Response data

Output Example

{"data":{"id":"70413a06-38d6-4c85-92b8-5ebc900d42e2","tinyId":"1791","alias":"event_573","message":"Our servers are in danger","status":"closed","acknowledged":false,"isSeen":true,"tags":["OverwriteQuietHours","Critical"],"snoozed":true,"snoozedUntil":"2017-04-03T20:32:35.143Z","count":79,"lastOccurredAt":"2017-04-03T20:05:50.894Z","createdAt":"2017-03-21T20:32:52.353Z","updatedAt":"2017-04-03T20:32:57.301Z","source":"Isengard"},"requestId":"9ae63dd7-ed00-4c81-86f0-c4ffd33142c9"}

Get Request Status

OpsGenie get request status

Endpoint

URL: v2/alerts/requests/{{requestId}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.requestId	string	Required	Parameters for the Get Request Status action

Input Example

{"path_parameters":{"requestId":"513085b8-caf3-4f91-aa23-be5fdefc3570"}}

Output

Parameter	Type	Description
data	object	Response data
data.success	boolean	Response data
data.action	string	Response data
data.processedAt	string	Response data
data.integrationId	string	Response data
data.isSuccess	boolean	Response data
data.status	string	Response data
data.alertId	string	Response data
data.alias	string	Response data
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"data":{"success":true,"action":"Create","processedAt":"2017-05-24T14:24:20.844Z","integrationId":"c9cec2cb-e782-4ebb-bc1d-1b2fa703cf03","isSuccess":true,"status":"Created alert","alertId":"8743a1b2-11da-480e-8493-744660987bef","alias":"8743a1b2-11da-480e-8493-744660987bef"},"took":0.022,"requestId":"ec7e1d8e-1c75-442e-a271-731070a7fa4d"}

list alerts

list alert opsgenie alert api

Endpoint

URL: v2/alerts

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Optional	Parameters for the list alerts action
parameters.offset	number	Optional	Parameters for the list alerts action
parameters.limit	number	Optional	Parameters for the list alerts action
parameters.sort	string	Optional	Parameters for the list alerts action
parameters.order	string	Optional	Parameters for the list alerts action
parameters.searchIdentifier	string	Optional	Parameters for the list alerts action
parameters.searchIdentifierType	string	Optional	Parameters for the list alerts action

Input Example

{"parameters":{"query":"status:open","offset":7,"limit":10,"sort":"createdAt","order":"desc","searchIdentifier":"70413a06-38d6-4c85-92b8-5ebc900d42e2","searchIdentifierType":"id"}}

Output

Parameter	Type	Description
data	array	Response data
data.id	string	Response data
data.tinyId	string	Response data
data.alias	string	Response data
data.message	string	Response data
data.status	string	Response data
data.acknowledged	boolean	Response data
data.isSeen	boolean	Response data
data.tags	array	Response data
data.snoozed	boolean	Response data
data.snoozedUntil	string	Response data
data.count	number	Response data
data.lastOccurredAt	string	Response data
data.createdAt	string	Response data
data.updatedAt	string	Response data
data.source	string	Response data
data.owner	string	Response data
data.priority	string	Response data
data.responders	array	Response data
data.responders.file_name	string	Response data
data.responders.file	string	Response data
data.integration	object	Response data
data.integration.id	string	Response data
data.integration.name	string	Response data
data.integration.type	string	Response data

Output Example

{"data":[{"id":"70413a06-38d6-4c85-92b8-5ebc900d42e2","tinyId":"1791","alias":"event_573","message":"Our servers are in danger","status":"closed","acknowledged":false,"isSeen":true,"tags":[],"snoozed":true,"snoozedUntil":"2017-04-03T20:32:35.143Z","count":79,"lastOccurredAt":"2017-04-03T20:05:50.894Z","createdAt":"2017-03-21T20:32:52.353Z","updatedAt":"2017-04-03T20:32:57.301Z","source":"Isengard"},{"id":"70413a06-38d6-4c85-92b8-5ebc900d42e2","tinyId":"1791","alias":"event_573","message":"Sample...

Remove Tags from Alert

OpsGenie remove tags from alert

Endpoint

URL: v2/alerts/{{identifier}}/tags

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Remove Tags from Alert action
parameters.identifierType	string	Optional	Parameters for the Remove Tags from Alert action
parameters.tags	string	Required	Parameters for the Remove Tags from Alert action
parameters.user	string	Optional	Parameters for the Remove Tags from Alert action
parameters.source	string	Optional	Parameters for the Remove Tags from Alert action
parameters.note	string	Optional	Parameters for the Remove Tags from Alert action

Input Example

{"parameters":{"identifierType":"id","tags":"OverwriteQuietHours,Critical","user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Snooze Alert

OpsGenie snooze alert

Endpoint

URL: v2/alerts/{{identifier}}/snooze

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Snooze Alert action
parameters.identifierType	string	Optional	Parameters for the Snooze Alert action
endTime	string	Optional	Time value
user	string	Optional	Parameter for Snooze Alert
source	string	Optional	Parameter for Snooze Alert
note	string	Optional	Parameter for Snooze Alert

Input Example

{"parameters":{"identifierType":"id"},"json_body":{"endTime":"2017-04-03T20:05:50.894Z","user":"Monitoring Script","source":"AWS Lambda","note":"Action executed via Alert API"},"path_parameters":{"identifier":"8418d193-2dab-4490-b331-8c02cdd196b7"}}

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Unacknowledge Alert

OpsGenie unackowledge alert

Endpoint

URL: v2/alerts/{{identifier}}/unacknowledge

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.identifier	string	Required	Parameters for the Unacknowledge Alert action
parameters.identifierType	string	Optional	Parameters for the Unacknowledge Alert action
user	string	Optional	Parameter for Unacknowledge Alert
source	string	Optional	Parameter for Unacknowledge Alert
note	string	Optional	Parameter for Unacknowledge Alert

Input Example

Output

Parameter	Type	Description
result	string	Result of the operation
took	number	Output field: took
requestId	string	Unique identifier

Output Example

{"result":"Request will be processed","took":0.302,"requestId":"43a29c5c-3dbf-4fa4-9c26-f4f71023e120"}

Response Headers

Header	Description	Example
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT