Retrieve bulk action - Trigger.dev

GET

/

api

/

v1

/

bulk-actions

/

{bulkActionId}

TypeScript

import { runs } from "@trigger.dev/sdk";

const action = await runs.bulk.retrieve("bulk_1234");

console.log(action.status, action.counts);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.trigger.dev/api/v1/bulk-actions/{bulkActionId}', 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/bulk-actions/{bulkActionId}",
  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/bulk-actions/{bulkActionId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/bulk-actions/{bulkActionId}")

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

{
  "id": "bulk_1234",
  "type": "CANCEL",
  "status": "PENDING",
  "counts": {
    "total": 123,
    "success": 123,
    "failure": 123
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

bulkActionId

string

required

The ID of a bulk action, starts with bulk_.

Response

Successful request

id

string

required

The bulk action ID, prefixed with bulk_.

Example:

"bulk_1234"

type

enum<string>

required

Available options:

CANCEL,

REPLAY

status

enum<string>

required

Available options:

PENDING,

COMPLETED,

ABORTED

counts

object

required

Show child attributes

createdAt

string<date-time>

required

name

string

The name provided when the bulk action was created.

completedAt

string<date-time>

⌘I

TypeScript

import { runs } from "@trigger.dev/sdk";

const action = await runs.bulk.retrieve("bulk_1234");

console.log(action.status, action.counts);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.trigger.dev/api/v1/bulk-actions/{bulkActionId}', 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/bulk-actions/{bulkActionId}",
  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/bulk-actions/{bulkActionId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/bulk-actions/{bulkActionId}")

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

{
  "id": "bulk_1234",
  "type": "CANCEL",
  "status": "PENDING",
  "counts": {
    "total": 123,
    "success": 123,
    "failure": 123
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "completedAt": "2023-11-07T05:31:56Z"
}