The notify function in the OpsgenieProvider use OpsGenie CreateAlertPayload:


userstrDisplay name of the request owner[optional]
notestrAdditional note that will be added while creating the alert[optional]
sourcestrSource field of the alert. Default value is IP address of the incoming request[optional]
messagestrMessage of the alert
aliasstrClient-defined identifier of the alert, that is also the key element of alert deduplication.[optional]
descriptionstrDescription field of the alert that is generally used to provide a detailed information about the alert.[optional]
responderslist[Recipient]Responders that the alert will be routed to send notifications[optional]
visible_tolist[Recipient]Teams and users that the alert will become visible to without sending any notification[optional]
actionslist[str]Custom actions that will be available for the alert[optional]
tagslist[str]Tags of the alert[optional]
detailsdict(str, str)Map of key-value pairs to use as custom properties of the alert[optional]
entitystrEntity field of the alert that is generally used to specify which domain alert is related to[optional]
prioritystrPriority level of the alert[optional]

Authentication Parameters

The OpsgenieProviderAuthConfig class takes the following parameters:

api_key (str | None): API key, which is a user or team API key. Optional, default is `None`. *Required*

Connecting with the Provider

To use the Opsgenie Provider, you’ll need to provide api_key.

You can create an integration key under Settings -> Integrations -> Add API Note: if you are in the free tier, the integration key can be created under Teams -> Your team -> Integrations -> Add Integration (API)


Certain scopes may be required to perform specific actions or queries via the Opsgenie Provider. Below is a summary of relevant scopes and their use cases:

  • opsgenie:create (Create alerts) Required: True Description: It allows to create, close and comment OpsGenie alerts.