The createOpsGenieAction() GraphQL mutation may be used to create an OpsGenie action.

For more information on creating an OpsGenie action, see the Action Type: OpsGenie documentation page. You may also want to look at the Actions page for related information.

Syntax

Below is the syntax for the createOpsGenieAction() mutation field:

graphql
createOpsGenieAction(
      input: CreateOpsGenieAction!
   ): OpsGenieAction!

Given Datatypes

For the input createOpsGenieAction(), there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: CreateOpsGenieAction

ParameterTypeRequired[a]DefaultDescription
viewNamestringyes Name of the view of the action.
namestringyes Name of the action.
apiUrlstringyes OpsGenie webhook URL to where the request is to be sent.
genieKeystringyes Key to authenticate with OpsGenie.
useProxybooleanyes Defines whether the action should use the configured proxy to make web requests.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

The returned datatype OpsGenieAction has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: OpsGenieAction

ParameterTypeRequired[a]DefaultDescription
apiUrlstringyes OpsGenie webhook url to send the request to.
genieKeystringyes Key to authenticate with OpsGenie.
useProxybooleanyes Defines whether the action should use the configured proxy to make web requests.
namestringyes The name of the action.
displayNamestringyes The display name of the action.
idstringyes The unique identifier of the action.
yamlTemplateYAMLyes A template that can be used to recreate the action.
packagePackageInstallation  The package, if any, of which the action is part (see PackageInstallation Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.