Summary

The createCustomLinkInteraction() GraphQL mutation field is used to create a custom link interaction.

API Stability Long-Term

Syntax

graphql
createCustomLinkInteraction(
       input: CreateCustomLinkInteractionInput!
    ): InteractionId!

For the input, you'll have to give the name of the custom link interaction to create, a list of interaction conditions, etc. See the Input Parameters section for details.

For the results, you'll get only the unique identifier of the interaction link. See the Returned Values section.

Example

Raw
graphql
mutation {
  createCustomLinkInteraction(input:
     { path: "humio",
       customLinkInteractionInput:{name: "my-interaction", openInNewTab: true,
                                   urlTemplate: "https://company.com?q={{ fields.myField }}"},
     } )
  { id }
}
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 {
  createCustomLinkInteraction(input:
     { path: \"humio\",
       customLinkInteractionInput:{name: \"my-interaction\", openInNewTab: true,
                                   urlTemplate: \"https://company.com?q={{ fields.myField }}\"},
     } )
  { id }
}"
}
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 {
  createCustomLinkInteraction(input:
     { path: \"humio\",
       customLinkInteractionInput:{name: \"my-interaction\", openInNewTab: true,
                                   urlTemplate: \"https://company.com?q={{ fields.myField }}\"},
     } )
  { id }
}"
}
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 { ^
  createCustomLinkInteraction(input: ^
     { path: \"humio\", ^
       customLinkInteractionInput:{name: \"my-interaction\", openInNewTab: true, ^
                                   urlTemplate: \"https://company.com?q={{ fields.myField }}\"}, ^
     } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createCustomLinkInteraction(input:
     { path: \"humio\",
       customLinkInteractionInput:{name: \"my-interaction\", openInNewTab: true,
                                   urlTemplate: \"https://company.com?q={{ fields.myField }}\"},
     } )
  { id }
}"
}'
    "$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 {
  createCustomLinkInteraction(input:
     { path: \"humio\",
       customLinkInteractionInput:{name: \"my-interaction\", openInNewTab: true,
                                   urlTemplate: \"https://company.com?q={{ fields.myField }}\"},
     } )
  { id }
}";
$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 {
  createCustomLinkInteraction(input:
     { path: \"humio\",
       customLinkInteractionInput:{name: \"my-interaction\", openInNewTab: true,
                                   urlTemplate: \"https://company.com?q={{ fields.myField }}\"},
     } )
  { id }
}"
}'''

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 {
  createCustomLinkInteraction(input:
     { path: \"humio\",
       customLinkInteractionInput:{name: \"my-interaction\", openInNewTab: true,
                                   urlTemplate: \"https://company.com?q={{ fields.myField }}\"},
     } )
  { id }
}"
}
);


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": {
    "createCustomLinkInteraction": {
      "id": "abc123"
    }
  }
}

Input Parameters

For the input, you would provide the name of the custom link interaction to create, a list of interaction conditions (i.e., fields and their arguments), and other parameters. These are listed in the table below, along with links to sub-parameters used:

Table: CreateCustomLinkInteractionInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 17, 2024
customLinkInteractionInputCustomLinkInteractionInputyes Long-TermThe custom link for interactions. See CustomLinkInteractionInput.
pathstringyes Long-TermThe path for the link.

The datatype above uses another datatype for giving custom link interaction information. For your convenience, the table for that sub-datatype is included here:

Table: CustomLinkInteractionInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 17, 2024
fieldInteractionConditions[FieldInteractionConditionInput]yes Long-TermThe field interaction conditions. See FieldInteractionConditionInput.
namestringyes Long-TermThe name of the field.
openInNewTabbooleanyes Long-TermWhether to open in a new tab.
titleTemplatestring  Long-TermThe title template.
urlEncodeArgsboolean  Long-TermThe URL encode arguments.
urlTemplatestringyes Long-TermThe URL template.

Returned Values

This mutation returns only the unique identifier of the interaction link. The table below provide a little more details:

Table: InteractionId Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
idstringyes Long-TermThe unique identifier for the interaction.