Complete a waitpoint token

Completes a waitpoint token, unblocking any run that is waiting for it via wait.forToken(). An optional data payload can be passed and will be returned to the waiting run. If the token is already completed, this is a no-op and returns success: true.

This endpoint accepts both secret API keys and short-lived JWTs (public access tokens), making it safe to call from frontend clients.

POST /api/v1/waitpoints/tokens/{waitpointId}/complete

TypeScript

TypeScript

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

// Complete with data (returned to the waiting run)
await wait.completeToken(token, {
  status: "approved",
  comment: "Looks good to me!",
});

// Complete with no data
await wait.completeToken(token, {});

curl --request POST \
  --url https://api.trigger.dev/api/v1/waitpoints/tokens/{waitpointId}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "status": "approved",
    "comment": "Looks good to me!"
  }
}
'

import requests

url = "https://api.trigger.dev/api/v1/waitpoints/tokens/{waitpointId}/complete"

payload = { "data": {
        "status": "approved",
        "comment": "Looks good to me!"
    } }
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({data: {status: 'approved', comment: 'Looks good to me!'}})
};

fetch('https://api.trigger.dev/api/v1/waitpoints/tokens/{waitpointId}/complete', 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/waitpoints/tokens/{waitpointId}/complete",
  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([
    'data' => [
        'status' => 'approved',
        'comment' => 'Looks good to me!'
    ]
  ]),
  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.trigger.dev/api/v1/waitpoints/tokens/{waitpointId}/complete"

	payload := strings.NewReader("{\n  \"data\": {\n    \"status\": \"approved\",\n    \"comment\": \"Looks good to me!\"\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.trigger.dev/api/v1/waitpoints/tokens/{waitpointId}/complete")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"status\": \"approved\",\n    \"comment\": \"Looks good to me!\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/waitpoints/tokens/{waitpointId}/complete")

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  \"data\": {\n    \"status\": \"approved\",\n    \"comment\": \"Looks good to me!\"\n  }\n}"

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

200

{
  "success": true
}

Authorizations

secretKeypublicAccessToken

Authorization · string · header · required

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

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_1234" });

Path Parameters

waitpointId · string · required

The ID of the waitpoint token to complete.

Body

application/json

data · any

Any JSON-serializable value to pass back to the run waiting on this token. The data will be returned from wait.forToken() as the result payload.

Example:

{
  "status": "approved",
  "comment": "Looks good to me!"
}

Response

200

application/json

Waitpoint token completed successfully

success · enum<boolean> · required

Always true when the request succeeds.

Available options: true