Skip to main content
POST
TypeScript

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.

Path Parameters

waiterId
string
required

The waiter's id, which is also its waitpoint id.

Response

Successful request

cancelled
boolean
required
reason
enum<string>

Present when cancelled is false. A delivery already claimed the waiter.

Available options:
too_late
deliveryId
string

With too_late, the delivery that resumed the run.

Example:

"whd_1234"