Skip to main content
PATCH
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_

widgetId
string
required

The widget id

Body

application/json
title
string
query
string
display
Table · object

How the widget renders its query results.

fillGaps
boolean
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

The updated dashboard

id
string

The dashboard id, starting with dashboard_

title
string
description
string
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.

createdAt
string<date-time>
updatedAt
string<date-time>
widgets
object[]

Widgets in grid order, top to bottom then left to right.