createCustomLinkInteraction()

API Stability	`Long-Term`

The createCustomLinkInteraction() GraphQL mutation field is used to create a custom link interaction. This is a preview, though, and subject to change.

Syntax

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

graphql

createCustomLinkInteraction(
       input: CreateCustomLinkInteractionInput!
    ): InteractionId!

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

Show:

graphql

mutation {
  createCustomLinkInteraction(input:
     { path: "humio",
       customLinkInteractionInput:{name: "my-interaction", openInNewTab: true,
                                   urlTemplate: "https://company.com?q={{ fields.myField }}"},
     } )
  { id }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

#! /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)

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/graphql',
  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

Show:

json

{
  "data": {
    "createCustomLinkInteraction": {
      "id": "ZLP9jEExnGyi6IXWZp2PBG9EMdtQSYTV"
    }
  }
}

Given Datatypes

For CreateCustomLinkInteractionInput, there are a few parameters. Below is a list of them:

Table: CreateCustomLinkInteractionInput

Parameter	Type	Required	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
`customLinkInteractionInput`	`CustomLinkInteractionInput`	yes	The custom link for interactions. See `CustomLinkInteractionInput`.
`path`	string	yes	The path for the link.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, InteractionId. Below is the parameter of that datatype:

Table: InteractionId

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 25, 2024
`id`	string	yes	`Long-Term`	The unique identifier for the interaction.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes