Runs API
Retrieve run events
Returns all OTel span events for a run. Useful for debugging and observability.
GET
/
api
/
v1
/
runs
/
{runId}
/
events
TypeScript
const response = await fetch("https://api.trigger.dev/api/v1/runs/run_1234/events", {
headers: {
Authorization: `Bearer ${process.env.TRIGGER_SECRET_KEY}`,
},
});
const { events } = await response.json();curl --request GET \
--url https://api.trigger.dev/api/v1/runs/{runId}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.trigger.dev/api/v1/runs/{runId}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.trigger.dev/api/v1/runs/{runId}/events', 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.trigger.dev/api/v1/runs/{runId}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.trigger.dev/api/v1/runs/{runId}/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.trigger.dev/api/v1/runs/{runId}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trigger.dev/api/v1/runs/{runId}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"events": [
{
"spanId": "<string>",
"parentId": "<string>",
"runId": "<string>",
"message": "<string>",
"startTime": "<string>",
"duration": 123,
"isError": true,
"isPartial": true,
"isCancelled": true,
"level": "TRACE",
"kind": "UNSPECIFIED",
"attemptNumber": 123,
"taskSlug": "<string>",
"events": [
{
"name": "<string>",
"time": "2023-11-07T05:31:56Z",
"properties": {}
}
],
"style": {
"icon": "<string>",
"variant": "<string>",
"accessory": {
"text": "<string>",
"style": "codepath"
}
}
}
]
}{
"error": "Invalid or Missing API key"
}{
"error": "Run not found"
}Authorizations
Use a named environment API key. It starts with tr_dev_sk_, tr_prod_sk_, tr_stg_sk_, etc.
Create a named API key in the API Keys section of your Trigger.dev project dashboard. Choose the narrowest access preset that supports your integration.
Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.
import { configure } from "@trigger.dev/sdk"; configure({ accessToken: "tr_dev_sk_1234" });
Path Parameters
The ID of an run, starts with run_. The run ID will be returned when you trigger a run on a task.
Response
Successful request
Show child attributes
Show child attributes
Was this page helpful?
⌘I
TypeScript
const response = await fetch("https://api.trigger.dev/api/v1/runs/run_1234/events", {
headers: {
Authorization: `Bearer ${process.env.TRIGGER_SECRET_KEY}`,
},
});
const { events } = await response.json();curl --request GET \
--url https://api.trigger.dev/api/v1/runs/{runId}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.trigger.dev/api/v1/runs/{runId}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.trigger.dev/api/v1/runs/{runId}/events', 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.trigger.dev/api/v1/runs/{runId}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.trigger.dev/api/v1/runs/{runId}/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.trigger.dev/api/v1/runs/{runId}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trigger.dev/api/v1/runs/{runId}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"events": [
{
"spanId": "<string>",
"parentId": "<string>",
"runId": "<string>",
"message": "<string>",
"startTime": "<string>",
"duration": 123,
"isError": true,
"isPartial": true,
"isCancelled": true,
"level": "TRACE",
"kind": "UNSPECIFIED",
"attemptNumber": 123,
"taskSlug": "<string>",
"events": [
{
"name": "<string>",
"time": "2023-11-07T05:31:56Z",
"properties": {}
}
],
"style": {
"icon": "<string>",
"variant": "<string>",
"accessory": {
"text": "<string>",
"style": "codepath"
}
}
}
]
}{
"error": "Invalid or Missing API key"
}{
"error": "Run not found"
}
