updateWebhookAction()

🎯API Stability

Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

Webhook actions send an HTTP request to a configured endpoint when an alert fires. The updateWebhookAction() mutation edits a webhook action in a view or repository. You can change the action's name, target URL, HTTP method, request headers, body template, SSL validation behavior, or proxy settings.

This mutation fully replaces the existing configuration. Supply every field in the input, including fields you are not changing.

Use createWebhookAction() to create a webhook action, or testWebhookAction() to test one without firing any alerts. To remove an action, use deleteActionV2(). To add labels to an action, use addActionLabels().

Hide Query Example

Show Webhook Actions Query

The repository() query returns a list of webhook actions for a repository:

graphql

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

For more information on webhook actions, see Action Type: Webhooks. For related information, see Actions.

Syntax

graphql

updateWebhookAction(
      input: UpdateWebhookAction!
   ): WebhookAction!

The mutation takes a single required input argument of type UpdateWebhookAction. Supply the view name, the action ID, and all configuration fields for the webhook action. The mutation returns a non-null WebhookAction object reflecting the updated state.

To retrieve the current action ID, use the repository() query.

Input parameters

Provide the viewName, the action id, and all configuration fields. The following table describes all available fields of the UpdateWebhookAction input type:

Table: UpdateWebhookAction Input Datatype

Parameter	Type	Required	Stability	Description
bodyTemplate	String	yes	`Long-Term`	Body of the http(s) request. Can be templated with values from the result.
headers	HttpHeaderEntryInput	yes	`Long-Term`	Headers of the http(s) request. See HttpHeaderEntryInput.
id	String	yes	`Long-Term`	The unique identifier of the action.
ignoreSSL	Boolean	yes	`Long-Term`	Flag indicating whether SSL should be ignored for the request.
labels	String	yes		Labels to categorize the action.
method	String	yes	`Long-Term`	The method to use for the request.
name	String	yes	`Long-Term`	The name of the action.
url	String	yes	`Long-Term`	The URL where to send the http(s) request.
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.

Example

Raw

graphql

mutation {
  updateWebhookAction( input:
    { viewName: "humio",
      id: "abc123",
      name: "my-webhook-action",
      url: "https://webhook.company.com",
      method: "POST",
      headers: [ {header: "Content-Type", value: "application/json"} ],
      bodyTemplate: 
             """{"repository": "{repo_name}","timestamp": "{triggered_timestamp}",
                "alert": { "name": "{name}", "query": {"queryString": "{query_string}"} },
                "warnings": "{warnings}", 
                "events": {events}, 
                "numberOfEvents": {event_count} }""",
      ignoreSSL: false,
      useProxy: false
    } )
  { 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 {
  updateWebhookAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"my-webhook-action\",
      url: \"https://webhook.company.com\",
      method: \"POST\",
      headers: [ {header: \"Content-Type\", value: \"application/json\"} ],
      bodyTemplate: 
             \"\"\"{\"repository\": \"{repo_name}\",\"timestamp\": \"{triggered_timestamp}\",
                \"alert\": { \"name\": \"{name}\", \"query\": {\"queryString\": \"{query_string}\"} },
                \"warnings\": \"{warnings}\", 
                \"events\": {events}, 
                \"numberOfEvents\": {event_count} }\"\"\",
      ignoreSSL: false,
      useProxy: false
    } )
  { 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 {
  updateWebhookAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"my-webhook-action\",
      url: \"https://webhook.company.com\",
      method: \"POST\",
      headers: [ {header: \"Content-Type\", value: \"application/json\"} ],
      bodyTemplate: 
             \"\"\"{\"repository\": \"{repo_name}\",\"timestamp\": \"{triggered_timestamp}\",
                \"alert\": { \"name\": \"{name}\", \"query\": {\"queryString\": \"{query_string}\"} },
                \"warnings\": \"{warnings}\", 
                \"events\": {events}, 
                \"numberOfEvents\": {event_count} }\"\"\",
      ignoreSSL: false,
      useProxy: false
    } )
  { 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 { ^
  updateWebhookAction( input: ^
    { viewName: \"humio\", ^
      id: \"abc123\", ^
      name: \"my-webhook-action\", ^
      url: \"https://webhook.company.com\", ^
      method: \"POST\", ^
      headers: [ {header: \"Content-Type\", value: \"application/json\"} ], ^
      bodyTemplate:  ^
             \"\"\"{\"repository\": \"{repo_name}\",\"timestamp\": \"{triggered_timestamp}\", ^
                \"alert\": { \"name\": \"{name}\", \"query\": {\"queryString\": \"{query_string}\"} }, ^
                \"warnings\": \"{warnings}\",  ^
                \"events\": {events},  ^
                \"numberOfEvents\": {event_count} }\"\"\", ^
      ignoreSSL: false, ^
      useProxy: false ^
    } ) ^
  { isAllowedToRun } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateWebhookAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"my-webhook-action\",
      url: \"https://webhook.company.com\",
      method: \"POST\",
      headers: [ {header: \"Content-Type\", value: \"application/json\"} ],
      bodyTemplate: 
             \"\"\"{\"repository\": \"{repo_name}\",\"timestamp\": \"{triggered_timestamp}\",
                \"alert\": { \"name\": \"{name}\", \"query\": {\"queryString\": \"{query_string}\"} },
                \"warnings\": \"{warnings}\", 
                \"events\": {events}, 
                \"numberOfEvents\": {event_count} }\"\"\",
      ignoreSSL: false,
      useProxy: false
    } )
  { 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 {
  updateWebhookAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"my-webhook-action\",
      url: \"https://webhook.company.com\",
      method: \"POST\",
      headers: [ {header: \"Content-Type\", value: \"application/json\"} ],
      bodyTemplate: 
             \"\"\"{\"repository\": \"{repo_name}\",\"timestamp\": \"{triggered_timestamp}\",
                \"alert\": { \"name\": \"{name}\", \"query\": {\"queryString\": \"{query_string}\"} },
                \"warnings\": \"{warnings}\", 
                \"events\": {events}, 
                \"numberOfEvents\": {event_count} }\"\"\",
      ignoreSSL: false,
      useProxy: false
    } )
  { 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 {
  updateWebhookAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"my-webhook-action\",
      url: \"https://webhook.company.com\",
      method: \"POST\",
      headers: [ {header: \"Content-Type\", value: \"application/json\"} ],
      bodyTemplate: 
             \"\"\"{\"repository\": \"{repo_name}\",\"timestamp\": \"{triggered_timestamp}\",
                \"alert\": { \"name\": \"{name}\", \"query\": {\"queryString\": \"{query_string}\"} },
                \"warnings\": \"{warnings}\", 
                \"events\": {events}, 
                \"numberOfEvents\": {event_count} }\"\"\",
      ignoreSSL: false,
      useProxy: false
    } )
  { 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 {
  updateWebhookAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"my-webhook-action\",
      url: \"https://webhook.company.com\",
      method: \"POST\",
      headers: [ {header: \"Content-Type\", value: \"application/json\"} ],
      bodyTemplate: 
             \"\"\"{\"repository\": \"{repo_name}\",\"timestamp\": \"{triggered_timestamp}\",
                \"alert\": { \"name\": \"{name}\", \"query\": {\"queryString\": \"{query_string}\"} },
                \"warnings\": \"{warnings}\", 
                \"events\": {events}, 
                \"numberOfEvents\": {event_count} }\"\"\",
      ignoreSSL: false,
      useProxy: false
    } )
  { 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": {
    "updateWebhookAction": {
      "isAllowedToRun": true
    }
  }
}

Returned values

The mutation returns a non-null WebhookAction object. The returned fields include the target URL, HTTP method, headers, body template, SSL and proxy settings, and labels. The object also includes creation and modification timestamps and the identity of the last modifying user.

Table: WebhookAction Datatype

Parameter	Type	Required	Stability	Description
allowedActions	[AssetAction]	yes	`Short-Term`	A list of allowed asset actions. See AssetAction. This is a preview and subject to change.
bodyTemplate	string	yes	`Long-Term`	Body of the http and https request. Can be templated with values from the result.
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.
headers	[HttpHeaderEntry]	yes	`Long-Term`	Headers of the http and https requests. See HttpHeaderEntry.
id	string	yes	`Long-Term`	The unique identifier of the action.
ignoreSSL	boolean	yes	`Long-Term`	Whether SSL should be ignored for the request.
isAllowedToRun	boolean	yes	`Long-Term`	Set to false to disable this type of action for security reasons.
labels	[string]	yes	`Preview`	Labels associated with the action.
method	string	yes	`Long-Term`	Method to use for the request.
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	yes	`Long-Term`	The package, if there is one, of which the action is part. See PackageInstallation.
packageId	VersionedPackageSpecifier		`Long-Term`	The unique identifier of the package. VersionedPackageSpecifier is a scalar.
requiresOrganizationOwnedQueriesPermissionToEdit	boolean	yes	`Long-Term`	This should be set to true if this action is used by triggers, where the query is run by the organization. If true, then the OrganizationOwnedQueries permission is required to edit the action. See Permission.
resource	string	yes	`Short-Term`	The resource identifier for the action.
url	string	yes	`Long-Term`	The URL where to send http and https requests.
useProxy	boolean	yes	`Long-Term`	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

GraphQL Queries

GraphQL Datatypes