Update a trigger

Update an automation. Every field is optional and what is left out is left alone, except actionParams, which replaces the delivery configuration as a whole. The delivery channel and an alert’s graph cannot be changed.

PATCH /api/v1/triggers/{triggerId}

Python

Python

import requests

url = "https://app.langwatch.ai/api/v1/triggers/{triggerId}"

payload = {
    "name": "<string>",
    "customGraphId": "<string>"
}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "name": "<string>",
  "action": "SEND_EMAIL",
  "actionParams": {},
  "graphAlert": {
    "threshold": 123,
    "operator": "gt",
    "timePeriod": 1,
    "seriesName": "<string>"
  },
  "report": {
    "source": {
      "kind": "dashboard",
      "dashboardId": "<string>"
    },
    "schedule": {
      "cron": "<string>",
      "timezone": "<string>"
    },
    "compareToPrevious": false
  },
  "filters": {},
  "filterQuery": "<string>",
  "kind": "AUTOMATION",
  "customGraphId": "<string>",
  "notificationCadence": "<string>",
  "traceDebounceMs": 123,
  "templates": {
    "slackTemplateType": "string",
    "slackTemplate": "<string>",
    "emailSubjectTemplate": "<string>",
    "emailBodyTemplate": "<string>"
  },
  "active": true,
  "message": "<string>",
  "alertType": "CRITICAL",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "platformUrl": "<string>"
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Path Parameters

triggerId · string · required

Minimum string length: 1

Body

application/json

name · string

Minimum string length: 1

active · boolean

message · string | null

alertType · enum<string> | null

Available options: CRITICAL, WARNING, INFO

filters · object

Show child attributes

filterQuery · string | null

The trace query this automation is about, in the syntax the traces view uses. When set it supersedes filters.

action · enum<string>

Available options: SEND_EMAIL, ADD_TO_DATASET, ADD_TO_ANNOTATION_QUEUE, SEND_SLACK_MESSAGE, SEND_WEBHOOK

customGraphId · string | null

The graph this alert watches, which an update cannot change. Accepted so that writing the read response back works; a different graph is refused. Create an alert on the other graph and delete this one.

actionParams · object

Replaces the delivery configuration as a whole rather than merging into it: send the fields this automation should have from now on, and anything left out is removed. The one exception is a credential the read hid: send back the [redacted] placeholder and the stored credential is kept (a Slack automation not yet on a connection has its stored secret moved into one), so reading an automation, changing one field and writing the whole object back is safe. Only this channel's fields are accepted; anything else is refused rather than dropped, and the rule this automation fires by belongs in graphAlert or report.

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

graphAlert · object

The rule this alert fires by. Only for an automation that is one.

Show child attributes

report · object

What this report renders and when. Only for one that is a report.

Show child attributes

templates · object

The Liquid templates this automation's message is rendered from. Absent fields render the LangWatch default for the channel.

Show child attributes

notificationCadence · enum<string>

How often a notification automation is allowed to send. A new one starts on a five-minute digest, which is what keeps a broad condition from sending a message per matching trace.

Available options: immediate, 5min_digest, 15min_digest, hourly_digest

traceDebounceMs · integer

How long to wait for a trace to settle before the conditions are read.

Required range: 0 <= x <= 600000

Response

200

application/json

Success

id · string · required

name · string · required

action · enum<string> · required

Available options: SEND_EMAIL, ADD_TO_DATASET, ADD_TO_ANNOTATION_QUEUE, SEND_SLACK_MESSAGE, SEND_WEBHOOK

actionParams · object · required

Where this automation delivers, with every credential value replaced by the [redacted] placeholder. Which channel is configured, which destination is set and which header names are in play all survive; the values never leave; a Slack automation names its connection by slackIntegrationId and carries no secret. Sending the placeholder back on an update keeps the stored value. The rule this automation fires by is not here: it is stated in graphAlert or report, and sending it in this field is refused.

Show child attributes

graphAlert · object | null · required

The rule an alert fires by. Null for anything that is not one.

Show child attributes

report · object | null · required

What a report renders and when. Null for anything else.

Show child attributes

filters · object · required

Show child attributes

filterQuery · string | null · required

kind · enum<string> · required

What this automation is about: matching traces, a metric crossing a threshold, or a schedule.

Available options: AUTOMATION, ALERT, REPORT

customGraphId · string | null · required

notificationCadence · string | null · required

traceDebounceMs · number | null · required

templates · object · required

The Liquid templates this automation's message is rendered from. Absent fields render the LangWatch default for the channel.

Show child attributes

active · boolean · required

message · string | null · required

alertType · enum<string> | null · required

Available options: CRITICAL, WARNING, INFO

createdAt · string · required

updatedAt · string · required

platformUrl · string<uri> · required