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

dashboardId
string
required

The custom dashboard id, starting with dashboard_

Body

application/json
title
string
required
Maximum string length: 200
display
Table · object
required

How the widget renders its query results.

id
string

Omit to generate one. Letters, numbers, _ and -, unique within the dashboard.

query
string

A TRQL query. Required unless the display type is title.

fillGaps
boolean

Fill empty time buckets, carrying gauges forward and zero-filling counters.

position
object

A position on the dashboard's 12-column grid.

revision
string

The revision from the dashboard you last read. Send it to reject the write with a 409 if someone else changed the dashboard in the meantime.

Response

Widget added

widgetId
string
dashboard
object