Add a trigger

Add a trigger

curl --request POST \
  --url https://api.extole.io/v6/jobs/{jobId}/triggers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "match_type": "EXACT",
  "parent_job_id": "parent_job_id",
  "pattern": "pattern",
  "trigger_type": "FILE_NAME_MATCHES"
}
'

import requests

url = "https://api.extole.io/v6/jobs/{jobId}/triggers"

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "match_type": "EXACT",
    "parent_job_id": "parent_job_id",
    "pattern": "pattern",
    "trigger_type": "FILE_NAME_MATCHES"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    match_type: 'EXACT',
    parent_job_id: 'parent_job_id',
    pattern: 'pattern',
    trigger_type: 'FILE_NAME_MATCHES'
  })
};

fetch('https://api.extole.io/v6/jobs/{jobId}/triggers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v6/jobs/{jobId}/triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'match_type' => 'EXACT',
    'parent_job_id' => 'parent_job_id',
    'pattern' => 'pattern',
    'trigger_type' => 'FILE_NAME_MATCHES'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/jobs/{jobId}/triggers"

	payload := strings.NewReader("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"match_type\": \"EXACT\",\n  \"parent_job_id\": \"parent_job_id\",\n  \"pattern\": \"pattern\",\n  \"trigger_type\": \"FILE_NAME_MATCHES\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v6/jobs/{jobId}/triggers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"match_type\": \"EXACT\",\n  \"parent_job_id\": \"parent_job_id\",\n  \"pattern\": \"pattern\",\n  \"trigger_type\": \"FILE_NAME_MATCHES\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/jobs/{jobId}/triggers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"match_type\": \"EXACT\",\n  \"parent_job_id\": \"parent_job_id\",\n  \"pattern\": \"pattern\",\n  \"trigger_type\": \"FILE_NAME_MATCHES\"\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "id": "<string>",
  "parent_job_id": "<string>",
  "trigger_type": "FILE_NAME_MATCHES",
  "match_type": "EXACT",
  "pattern": "<string>"
}

POST

jobs

{jobId}

triggers

Add a trigger

curl --request POST \
  --url https://api.extole.io/v6/jobs/{jobId}/triggers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "match_type": "EXACT",
  "parent_job_id": "parent_job_id",
  "pattern": "pattern",
  "trigger_type": "FILE_NAME_MATCHES"
}
'

import requests

url = "https://api.extole.io/v6/jobs/{jobId}/triggers"

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "match_type": "EXACT",
    "parent_job_id": "parent_job_id",
    "pattern": "pattern",
    "trigger_type": "FILE_NAME_MATCHES"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    match_type: 'EXACT',
    parent_job_id: 'parent_job_id',
    pattern: 'pattern',
    trigger_type: 'FILE_NAME_MATCHES'
  })
};

fetch('https://api.extole.io/v6/jobs/{jobId}/triggers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v6/jobs/{jobId}/triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'match_type' => 'EXACT',
    'parent_job_id' => 'parent_job_id',
    'pattern' => 'pattern',
    'trigger_type' => 'FILE_NAME_MATCHES'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/jobs/{jobId}/triggers"

	payload := strings.NewReader("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"match_type\": \"EXACT\",\n  \"parent_job_id\": \"parent_job_id\",\n  \"pattern\": \"pattern\",\n  \"trigger_type\": \"FILE_NAME_MATCHES\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v6/jobs/{jobId}/triggers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"match_type\": \"EXACT\",\n  \"parent_job_id\": \"parent_job_id\",\n  \"pattern\": \"pattern\",\n  \"trigger_type\": \"FILE_NAME_MATCHES\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/jobs/{jobId}/triggers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"match_type\": \"EXACT\",\n  \"parent_job_id\": \"parent_job_id\",\n  \"pattern\": \"pattern\",\n  \"trigger_type\": \"FILE_NAME_MATCHES\"\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "id": "<string>",
  "parent_job_id": "<string>",
  "trigger_type": "FILE_NAME_MATCHES",
  "match_type": "EXACT",
  "pattern": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

jobId

string

required

The unique identifier of the job that owns the trigger. Use the reserved value unattached to address triggers that are not attached to any job, which happens when a component defines a trigger whose parent_job_id expression evaluates to nothing.

Body

application/json

Option 1
Option 2

trigger_type

enum<string>

required

Available options:

FILE_NAME_MATCHES

match_type

required

How the pattern is matched against filenames. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.

Available options:

EXACT,

REGEX

pattern

required

Filename pattern to match. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.

component_ids

string[]

component_references

object[]

Show child attributes

parent_job_id

Id of the job this trigger belongs to. A literal job id or a buildtime expression resolved from component references when the trigger is saved; when omitted the trigger belongs to the job in the request path. Buildtime expressions use JobBuildtimeContext.

Response

Successful response

Option 1
Option 2

Stored file name matches trigger definition. Fields match_type and pattern are unevaluated and appear in buildtime-evaluatable form.

component_ids

string[]

required

component_references

object[]

required

Show child attributes

string

required

read-only

Unique id of the trigger.

parent_job_id

required

Id of the job this trigger belongs to, as the buildtime expression or literal that was saved. Buildtime expressions use JobBuildtimeContext.

trigger_type

enum<string>

required

Available options:

FILE_NAME_MATCHES

match_type

required

How the pattern is matched against filenames. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.

Available options:

EXACT,

REGEX

pattern

required

Filename pattern to match. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.

⌘I

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Authorizations

Path Parameters

Body

Response