> This page is for Itential Platform Cloud.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Run a trigger

POST https://example.itential.io/trigger-service/triggers/{triggerId}/execute
Content-Type: application/json

Runs a route-exposed on-demand trigger directly by its ID.

Reference: https://docs.itential.com/itential-cloud/api-reference/trigger-service/triggers-fire-trigger

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Path parameters

- `triggerId` (string, required) — The trigger's unique identifier (triggers._id), a UUIDv7.

### Body (application/json)

This endpoint expects an object.

- `inputs` (TriggerServiceTriggersTriggerIdExecutePostRequestBodyContentApplicationJsonSchemaInputs, optional) — Exact shape is unconfirmed.
- `targetType` (enum, optional) — One instance or a group. Replaces the Trigger's stored target type; ignored unless the Trigger is of a resource model.
  - Allowed values: `instance`, `group`
- `targetIdentifier` (string, optional) — Name of the instance or group. Replaces the Trigger's stored target identifier; ignored unless the Trigger is of a resource model.

## Response

### 200

result

- `executionId` (string, required) — Identifier of the Execution recorded for this fire.
- `assetId` (string, optional) — Id of the asset the fired Trigger targets: the id of the compliance plan for a compliance plan run, of the resource model for a resource model action, of the workflow for a workflow and of the agent definition for an agent.
- `run` (TriggerServiceTriggersTriggerIdExecutePostResponsesContentApplicationJsonSchemaRun, optional) — The run the fire started: its type and id. Absent when the target application started none, in which case notStartedReason says why.
- `jobId` (string, optional) — Id of the Workflow Engine Job that stands for the run. Absent when there is no run, and for a run that has no Job of its own.
- `notStartedReason` (string, optional) — Why the target application started no run although it accepted the call. Present only when run is absent.

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Types

### TriggerServiceTriggersTriggerIdExecutePostRequestBodyContentApplicationJsonSchemaInputs

Exact shape is unconfirmed.

### TriggerServiceTriggersTriggerIdExecutePostResponsesContentApplicationJsonSchemaRun

The run the fire started: its type and id. Absent when the target application started none, in which case notStartedReason says why.

- `type` (enum, required)
  - Allowed values: `workflow`, `agent`, `compliance_plan`, `resource_model_action`
- `id` (string, required)
- `assetId` (string, optional) — The asset the Trigger ran. For a resource_model_action run this is the resource model id. Absent when the Execution recorded none.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "executionId": "string",
  "assetId": "string",
  "run": {
    "type": "workflow",
    "id": "string",
    "assetId": "string"
  },
  "jobId": "string",
  "notStartedReason": "string"
}
```

**SDK Code**

```python
import requests

url = "https://example.itential.io/trigger-service/triggers/triggerId/execute"

payload = {}
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript
const url = 'https://example.itential.io/trigger-service/triggers/triggerId/execute';
const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://example.itential.io/trigger-service/triggers/triggerId/execute"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://example.itential.io/trigger-service/triggers/triggerId/execute")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://example.itential.io/trigger-service/triggers/triggerId/execute")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://example.itential.io/trigger-service/triggers/triggerId/execute', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://example.itential.io/trigger-service/triggers/triggerId/execute");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://example.itential.io/trigger-service/triggers/triggerId/execute")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```