The createEventForwardingRule() GraphQL mutation field is used to create an event forwarding rule on a repository and return it.

For more information on event forwardering rules, see the Event Forwarding Rules documentation page. You may also want to look at the Event Forwarding and the Events page for related information.

Syntax

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

graphql
createEventForwardingRule(
      input: CreateEventForwardingRule!
   ): EventForwardingRule!

Given Datatypes

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

Table: CreateEventForwardingRule

ParameterTypeRequired[a]DefaultDescription
repoNamestringyes The name of the repository of the event forwarding rule.
queryStringstringyes The query string for filtering and mapping the events to forward.
eventForwarderIdstringyes The id of the event forwarder.
languageVersionLanguageVersionEnum = legacyyes The version of Human language to use: legacy, xdr1, or xdrdetects1. If non-null, it will be a version known by the current LogScale installation. See LanguageVersionEnum 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.


Returned Datatypes

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

Table: EventForwardingRule

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier for the event forwarding rule.
queryStringstringyes The query string for filtering and mapping the events to forward.
eventForwarderIdstringyes The unique identifier of the event forwarder.
createdAtlongyes The UNIX timestamp of when the event forwarder was created.
languageVersionLanguageVersionyes The version of the LogScale query language to use (see LanguageVersion 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.