Core run

Submit a Core form as a technician

Provisioning forms only — a lookup-kind form (see the catalogue) has no run to start and is refused with 400. Same approval gate and compiled workflow as the Core app’s run page. submitter is your signed-in person and is recorded on the request; credential delivery (email / ticket) follows the form’s configuration using that email. secret — onboarding’s one-time credential — is returned once, here only: it is never stored, so an Idempotency-Key replay of this call returns "secret": null with an idempotentReplayNote.

Under an Idempotency-Key the run starts once however often the call is retried, a retry after a 5xx included: the retry gets the run the first call started, with "replayed": true and no secret when that run had already started. On this call the key must be printable ASCII, and it names its run for good, so use a new key for each run you mean to start. Requires the core:run key scope.

POST

api

core

forms

{slug}

run

curl

# Requires the core:run key scope.
# Idempotency-Key is optional: send one to make a retry safe.
curl -X POST "https://api.triggr-app.com/api/v1/core/forms/<slug>/run" \
  -H "Authorization: Bearer $TRIGGR_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "submission": {
    "std-first": "Jane",
    "std-last": "Doe",
    "std-upn": "jane.doe@acme.com"
  },
  "submitter": {
    "name": "Sam Tech",
    "email": "sam@acme-msp.com"
  }
}'

// Requires the core:run key scope.
// Idempotency-Key is optional: send one to make a retry safe.
const res = await fetch("https://api.triggr-app.com/api/v1/core/forms/<slug>/run", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TRIGGR_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "submission": {
      "std-first": "Jane",
      "std-last": "Doe",
      "std-upn": "jane.doe@acme.com"
    },
    "submitter": {
      "name": "Sam Tech",
      "email": "sam@acme-msp.com"
    }
  }),
});
if (!res.ok) throw new Error(`Triggr ${res.status}: ${await res.text()}`);
const data = await res.json();

# Requires the core:run key scope.
# Idempotency-Key is optional: send one to make a retry safe.
$headers = @{
  Authorization = "Bearer $env:TRIGGR_API_KEY"
  'Idempotency-Key' = [guid]::NewGuid().ToString()
}
$body = @'
{
  "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "submission": {
    "std-first": "Jane",
    "std-last": "Doe",
    "std-upn": "jane.doe@acme.com"
  },
  "submitter": {
    "name": "Sam Tech",
    "email": "sam@acme-msp.com"
  }
}
'@
Invoke-RestMethod -Method Post -Uri 'https://api.triggr-app.com/api/v1/core/forms/<slug>/run' -Headers $headers -ContentType 'application/json' -Body $body

import requests

url = "https://api.triggr-app.com/api/v1/core/forms/{slug}/run"

payload = {
    "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "submission": {
        "std-first": "Jane",
        "std-last": "Doe",
        "std-upn": "jane.doe@acme.com"
    },
    "submitter": {
        "email": "sam@acme-msp.com",
        "name": "Sam Tech"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clientId: 'c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f',
    submission: {'std-first': 'Jane', 'std-last': 'Doe', 'std-upn': 'jane.doe@acme.com'},
    submitter: {email: 'sam@acme-msp.com', name: 'Sam Tech'}
  })
};

fetch('https://api.triggr-app.com/api/v1/core/forms/{slug}/run', 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.triggr-app.com/api/v1/core/forms/{slug}/run",
  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([
    'clientId' => 'c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f',
    'submission' => [
        'std-first' => 'Jane',
        'std-last' => 'Doe',
        'std-upn' => 'jane.doe@acme.com'
    ],
    'submitter' => [
        'email' => 'sam@acme-msp.com',
        'name' => 'Sam Tech'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.triggr-app.com/api/v1/core/forms/{slug}/run"

	payload := strings.NewReader("{\n  \"clientId\": \"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"submission\": {\n    \"std-first\": \"Jane\",\n    \"std-last\": \"Doe\",\n    \"std-upn\": \"jane.doe@acme.com\"\n  },\n  \"submitter\": {\n    \"email\": \"sam@acme-msp.com\",\n    \"name\": \"Sam Tech\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.triggr-app.com/api/v1/core/forms/{slug}/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientId\": \"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"submission\": {\n    \"std-first\": \"Jane\",\n    \"std-last\": \"Doe\",\n    \"std-upn\": \"jane.doe@acme.com\"\n  },\n  \"submitter\": {\n    \"email\": \"sam@acme-msp.com\",\n    \"name\": \"Sam Tech\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.triggr-app.com/api/v1/core/forms/{slug}/run")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientId\": \"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"submission\": {\n    \"std-first\": \"Jane\",\n    \"std-last\": \"Doe\",\n    \"std-upn\": \"jane.doe@acme.com\"\n  },\n  \"submitter\": {\n    \"email\": \"sam@acme-msp.com\",\n    \"name\": \"Sam Tech\"\n  }\n}"

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

{
  "executionId": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
  "status": "awaiting_approval"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Organisation API key. Scoped operations carry x-triggr-scope; the scopes themselves are described in x-triggr-scopes.

Headers

Idempotency-Key

string

OPTIONAL — omit it and this operation behaves exactly as it always has. A unique value (a UUID) you choose per request. A retry with the same key and the same method, path and body within 24 hours gets the first response replayed (status and body, with Idempotent-Replayed: true) instead of running again; the same key with a different request is refused with 422. A 5xx is not stored, so that retry runs. A one-time credential is never stored: on a replay any secret is null, with an idempotentReplayNote explaining it.

Required string length: 1 - 255

Path Parameters

slug

string

required

Body

application/json

clientId

string

required

submission

object

required

fieldId → value

submitter

object

required

The person acting in your portal; at least one of name/email

Show child attributes

display

object

fieldId → human label for id/code-valued answers

Show child attributes

Response

executionId

string

required

status

enum<string>

required

Available options:

running,

awaiting_approval

idempotentReplayNote

string

Present only on an Idempotency-Key replay whose original response carried a one-time credential: says that the value is shown only in the original response and how to issue a fresh one

replayed

boolean

true only when an earlier call with this Idempotency-Key started this run: nothing new was started, and secret is not repeated. The response then also carries Idempotent-Replayed: true and an idempotentReplayNote

secret

object | null

The one-time credential, shown ONCE. null on an Idempotency-Key replay — see idempotentReplayNote

Show child attributes

curl

# Requires the core:run key scope.
# Idempotency-Key is optional: send one to make a retry safe.
curl -X POST "https://api.triggr-app.com/api/v1/core/forms/<slug>/run" \
  -H "Authorization: Bearer $TRIGGR_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "submission": {
    "std-first": "Jane",
    "std-last": "Doe",
    "std-upn": "jane.doe@acme.com"
  },
  "submitter": {
    "name": "Sam Tech",
    "email": "sam@acme-msp.com"
  }
}'

// Requires the core:run key scope.
// Idempotency-Key is optional: send one to make a retry safe.
const res = await fetch("https://api.triggr-app.com/api/v1/core/forms/<slug>/run", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TRIGGR_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "submission": {
      "std-first": "Jane",
      "std-last": "Doe",
      "std-upn": "jane.doe@acme.com"
    },
    "submitter": {
      "name": "Sam Tech",
      "email": "sam@acme-msp.com"
    }
  }),
});
if (!res.ok) throw new Error(`Triggr ${res.status}: ${await res.text()}`);
const data = await res.json();

# Requires the core:run key scope.
# Idempotency-Key is optional: send one to make a retry safe.
$headers = @{
  Authorization = "Bearer $env:TRIGGR_API_KEY"
  'Idempotency-Key' = [guid]::NewGuid().ToString()
}
$body = @'
{
  "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "submission": {
    "std-first": "Jane",
    "std-last": "Doe",
    "std-upn": "jane.doe@acme.com"
  },
  "submitter": {
    "name": "Sam Tech",
    "email": "sam@acme-msp.com"
  }
}
'@
Invoke-RestMethod -Method Post -Uri 'https://api.triggr-app.com/api/v1/core/forms/<slug>/run' -Headers $headers -ContentType 'application/json' -Body $body

import requests

url = "https://api.triggr-app.com/api/v1/core/forms/{slug}/run"

payload = {
    "clientId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "submission": {
        "std-first": "Jane",
        "std-last": "Doe",
        "std-upn": "jane.doe@acme.com"
    },
    "submitter": {
        "email": "sam@acme-msp.com",
        "name": "Sam Tech"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clientId: 'c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f',
    submission: {'std-first': 'Jane', 'std-last': 'Doe', 'std-upn': 'jane.doe@acme.com'},
    submitter: {email: 'sam@acme-msp.com', name: 'Sam Tech'}
  })
};

fetch('https://api.triggr-app.com/api/v1/core/forms/{slug}/run', 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.triggr-app.com/api/v1/core/forms/{slug}/run",
  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([
    'clientId' => 'c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f',
    'submission' => [
        'std-first' => 'Jane',
        'std-last' => 'Doe',
        'std-upn' => 'jane.doe@acme.com'
    ],
    'submitter' => [
        'email' => 'sam@acme-msp.com',
        'name' => 'Sam Tech'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.triggr-app.com/api/v1/core/forms/{slug}/run"

	payload := strings.NewReader("{\n  \"clientId\": \"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"submission\": {\n    \"std-first\": \"Jane\",\n    \"std-last\": \"Doe\",\n    \"std-upn\": \"jane.doe@acme.com\"\n  },\n  \"submitter\": {\n    \"email\": \"sam@acme-msp.com\",\n    \"name\": \"Sam Tech\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.triggr-app.com/api/v1/core/forms/{slug}/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientId\": \"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"submission\": {\n    \"std-first\": \"Jane\",\n    \"std-last\": \"Doe\",\n    \"std-upn\": \"jane.doe@acme.com\"\n  },\n  \"submitter\": {\n    \"email\": \"sam@acme-msp.com\",\n    \"name\": \"Sam Tech\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.triggr-app.com/api/v1/core/forms/{slug}/run")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientId\": \"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"submission\": {\n    \"std-first\": \"Jane\",\n    \"std-last\": \"Doe\",\n    \"std-upn\": \"jane.doe@acme.com\"\n  },\n  \"submitter\": {\n    \"email\": \"sam@acme-msp.com\",\n    \"name\": \"Sam Tech\"\n  }\n}"

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

{
  "executionId": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
  "status": "awaiting_approval"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Get started

Endpoints

Submit a Core form as a technician

Authorizations

Headers

Path Parameters

Body

Response