Skip to contentSkip to page list

Docs

Pause an automation

Pause an automation. A report stops claiming its schedule.

POST/api/v1/triggers/{triggerId}/disable
Request and response examples
request.py
import osimport requests​origin = "https://app.langwatch.ai"path = "/api/v1/triggers/<triggerId>/disable"api_key = os.environ["LANGWATCH_API_KEY"]headers = {    "X-Auth-Token": api_key,}​response = requests.post(    origin + path,    headers=headers,)print(response.json())

Success

application/json · Generated from schema

{  "id": "string",  "name": "string",  "action": "SEND_EMAIL",  "actionParams": {},  "graphAlert": {    "threshold": 0,    "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": 0,  "templates": {    "slackTemplateType": "string",    "slackTemplate": "string",    "emailSubjectTemplate": "string",    "emailBodyTemplate": "string"  },  "active": false,  "message": "string",  "alertType": "CRITICAL",  "createdAt": "string",  "updatedAt": "string",  "platformUrl": "string"}
api-reference/triggers/action-disable

Authorization

X-Auth-Tokenstringheaderrequired

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

triggerIdstringrequired
At least 1 character

Responses

200

Success

application/json

idstringrequired
namestringrequired
actionstringrequired
One of"SEND_EMAIL""ADD_TO_DATASET""ADD_TO_ANNOTATION_QUEUE""SEND_SLACK_MESSAGE""SEND_WEBHOOK"
actionParamsobjectrequired

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.

graphAlertobject | nullrequired

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

Option 1object
thresholdnumberrequired
operatorstringrequired
One of"gt""lt""gte""lte""eq"
timePeriodnumberrequired
seriesNamestringrequired
At least 1 character
Option 2null
reportobject | nullrequired

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

Option 1object
sourceobjectrequired
scheduleobjectrequired
compareToPreviousbooleanrequired
Default: false
Option 2null
filtersobjectrequired
filterQuerystring | nullrequired
kindstringrequired

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

One of"AUTOMATION""ALERT""REPORT"
customGraphIdstring | nullrequired
notificationCadencestring | nullrequired
traceDebounceMsnumber | nullrequired
templatesobjectrequired

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

slackTemplateTypestring | null
slackTemplatestring | null
emailSubjectTemplatestring | null
emailBodyTemplatestring | null
activebooleanrequired
messagestring | nullrequired
alertTypestring | nullrequired
Option 1string
Option 2null
createdAtstringrequired
updatedAtstringrequired
platformUrlstring (uri)required
404

Not Found

application/json

errorstringrequired
messagestring

Documentation