Skip to contentSkip to page list

Docs

Send a test fire

Send this automation's message to the destination it is configured with, so you can confirm it arrives. Nothing is recorded as a fire.

POST/api/v1/triggers/{triggerId}/test-fire
Request and response examples
request.py
import osimport requests​origin = "https://app.langwatch.ai"path = "/api/v1/triggers/<triggerId>/test-fire"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

{  "channel": "email",  "recipientCount": 0,  "usedDefault": false,  "missingVariables": [    "string"  ],  "errors": [    "string"  ],  "httpStatus": 0}
api-reference/triggers/action-test-fire

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

channelstringrequired
One of"email""slack""webhook"
recipientCountnumberrequired
usedDefaultbooleanrequired

Whether the LangWatch default message was rendered because this automation states no template of its own.

missingVariablesstring[]required
errorsstring[]required
httpStatusnumber

Webhook only: what the endpoint answered with.

404

Not Found

application/json

errorstringrequired
messagestring

Documentation