createOpsGenieAction()

Security Requirements and Controls

CreateActions API permission

API Stability Long-Term

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

To test an OpsGenie action, there is the testOpsGenieAction()() mutation. You can use the updateOpsGenieAction() to update one and the deleteActionV2() to delete an action.

Hide Query Example

Show OpsGenie Actions Query

To get a list of OpsGenie actions, you could use the repository() query like so:

graphql

query {
     repository(name: "humio")
        { id, name,
          actions { id, name, 
                    ... on OpsGenieAction { id, name } }
          }
   }

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

graphql

createOpsGenieAction(
      input: CreateOpsGenieAction!
   ): OpsGenieAction!

Example

Below is an example of how this mutation field might be used:

Raw

graphql

mutation {
  createOpsGenieAction(input:
    { viewName: "humio",
      name: "genie-act",
      genieKey: "PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ",
      apiUrl: "https://genie.company.com",
      useProxy: false
    } )
  { id, isAllowedToRun }
}

Mac OS or Linux (curl)

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      apiUrl: \"https://genie.company.com\",
      useProxy: false
    } )
  { id, isAllowedToRun }
}"
}
EOF

Mac OS or Linux (curl) One-line

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      apiUrl: \"https://genie.company.com\",
      useProxy: false
    } )
  { id, isAllowedToRun }
}"
}
EOF

Windows Cmd and curl

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  createOpsGenieAction(input: ^
    { viewName: \"humio\", ^
      name: \"genie-act\", ^
      genieKey: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\", ^
      apiUrl: \"https://genie.company.com\", ^
      useProxy: false ^
    } ) ^
  { id, isAllowedToRun } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      apiUrl: \"https://genie.company.com\",
      useProxy: false
    } )
  { id, isAllowedToRun }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

Perl

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      apiUrl: \"https://genie.company.com\",
      useProxy: false
    } )
  { id, isAllowedToRun }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";

Python

python

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      apiUrl: \"https://genie.company.com\",
      useProxy: false
    } )
  { id, isAllowedToRun }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

Node.js

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      apiUrl: \"https://genie.company.com\",
      useProxy: false
    } )
  { id, isAllowedToRun }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();

Example Responses

Success (HTTP Response Code 200 OK)

json

{
  "data": {
    "createOpsGenieAction": {
      "id": "bdN6ikgTdoRJHigZjvfoTThtGGBjRP4r",
      "isAllowedToRun": true
    }
  }
}

Given Datatype

For this input datatype, you would provide the name of the view associated with the action to create, the webhook URL where to send the request, where to send the request, the key to authenticate with OpsGenie, and some other parameters. These are listed and explained in the table below:

Table: CreateOpsGenieAction

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 17, 2024
apiUrl	string	yes	`Long-Term`	OpsGenie webhook URL to where the request is to be sent.
genieKey	string	yes	`Long-Term`	Key to authenticate with OpsGenie.
name	string	yes	`Long-Term`	Name of the action.
useProxy	boolean	yes	`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
viewName	string	yes	`Long-Term`	Name of the view of the action.

Returned Datatype

With the returned datatype you can get a list allowed actions, when the action was created and modified last and by whom, and other items. Of course, having just created the action using this mutation, you'll probably know all of this. For anything you don't know, check the table below:

Table: OpsGenieAction

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 30, 2025
allowedActions	[AssetAction]	yes	`Short-Term`	The allowed asset actions. See AssetAction . This is a preview and subject to change.
apiUrl	string	yes	`Long-Term`	OpsGenie webhook url to send the request to.
createdInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the creation of the action. See AssetCommitMetadata.
displayName	string	yes	`Long-Term`	The display name of the action.
genieKey	string	yes	`Long-Term`	Key to authenticate with OpsGenie.
id	string	yes	`Long-Term`	The unique identifier of the action.
isAllowedToRun	boolean	yes	`Long-Term`	Whether the action is enabled.
labels	[string]		`Preview`	Any labels associated with the action.
modifiedInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the latest modification of the action. See AssetCommitMetadata.
name	string	yes	`Long-Term`	The name of the action.
package	PackageInstallation		`Long-Term`	The package, if any, of which the action is part. See PackageInstallation.
requiresOrganizationOwnedQueriesPermissionToEdit	boolean	yes	`Long-Term`	True if this action is used by triggers, where the query is run by the organization. The OrganizationOwnedQueries permission is required to edit the action.
resource	string	yes	`Short-Term`	The resource identifier for the action.
useProxy	boolean	yes	`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
yamlTemplate	YAML	yes	`Long-Term`	A template that can be used to recreate the action. YAML is a scalar.

Versions of this Page

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes