TRtriggerdotdev
waitpoints

Retrieve a waitpoint token

Changed on

Retrieves a waitpoint token by its ID, including its current status and output if it has been completed.

get/api/v1/waitpoints/tokens/{waitpointId}

Request

Path parameters

waitpointIdstring required

The ID of the waitpoint token.

Response

Successful request

idstring required

The unique ID of the waitpoint token.

urlstring required

An HTTP callback URL. A POST request to this URL (with an optional JSON body) will complete the waitpoint without needing an API key.

status'WAITING' | 'COMPLETED' | 'TIMED_OUT' required

The current status of the waitpoint token.

idempotencyKeystring nullable

The idempotency key used when creating the token, if any.

idempotencyKeyExpiresAtstring date-time nullable

When the idempotency key expires.

timeoutAtstring date-time nullable

When the token will time out, if a timeout was set.

completedAtstring date-time nullable

When the token was completed, if it has been completed.

outputstring nullable

The serialized output data passed when completing the token. Only present when status is COMPLETED.

outputTypestring nullable

The content type of the output (e.g. "application/json").

outputIsErrorboolean nullable

Whether the output represents an error (e.g. a timeout).

tagsstring[] required

Tags attached to the waitpoint.

createdAtstring date-time required

When the waitpoint token was created.

Example response

{
  "id": "waitpoint_abc123",
  "url": "https://api.trigger.dev/api/v1/waitpoints/tokens/waitpoint_abc123/callback/abc123hash"
}

Changes