Response Actions
List all response actions
Filter by archived status (default: false)
List of response actions
Access denied
System not ready for requests
GET /app/api/v1/response-actions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": 1,
"trigger_def": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"trigger_tree_labels": [
"text"
],
"trigger_display_name": "text",
"trigger_fn_name": "text",
"trigger_arg_names": [
"text"
],
"script_var_names": [
"text"
],
"is_scriptable": true,
"is_runnable": true,
"display_index": 1,
"is_archived": true,
"parent": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"display_name": "text",
"is_enabled": true,
"is_archived": true
}
]Create a new response action
Response action created successfully
Bad request - invalid input
No user on API key
Access denied
Trigger definition not found
System not ready for requests
POST /app/api/v1/response-actions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 95
{
"display_name": "text",
"trigger_def_uuid": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
}{
"id": 1,
"trigger_def": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"trigger_tree_labels": [
"text"
],
"trigger_display_name": "text",
"trigger_fn_name": "text",
"trigger_arg_names": [
"text"
],
"script_var_names": [
"text"
],
"is_scriptable": true,
"is_runnable": true,
"display_index": 1,
"is_archived": true,
"parent": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"display_name": "text",
"is_enabled": true,
"is_archived": true
}Get response action details with version and run counts
Response action details with counts and latest version/run
Access denied
Response action not found
System not ready for requests
GET /app/api/v1/response-actions/{script_id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"counts": {
"version": 1,
"run": 1
},
"latest": {
"version": {},
"run": {}
}
}Archive (soft delete) a response action. Deletes unreferenced versions.
Response action archived successfully
No content
No user on API key
Access denied
Response action not found
System not ready for requests
DELETE /app/api/v1/response-actions/{script_id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Update response action properties
Response action updated successfully
No content
Bad request or cannot update archived action
No user on API key
Access denied
Response action or trigger definition not found
System not ready for requests
PATCH /app/api/v1/response-actions/{script_id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99
{
"display_name": "text",
"trigger_def_uuid": "123e4567-e89b-12d3-a456-426614174000",
"is_enabled": true
}No content
List all runs for a response action
List of response action runs
Access denied
Response action not found
GET /app/api/v1/response-actions/{script_id}/runs HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": 1,
"trigger_run": {
"id": 1,
"trigger_def": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"trigger_tree_labels": [
"text"
],
"trigger_display_name": "text",
"trigger_fn_name": "text",
"trigger_arg_names": [
"text"
],
"script_var_names": [
"text"
],
"is_scriptable": true,
"is_runnable": true,
"display_index": 1,
"is_archived": true,
"parent": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"trigger_args": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"batch": 1
},
"script": {
"id": 1,
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"display_name": "text",
"is_enabled": true,
"is_archived": true,
"trigger_def": "123e4567-e89b-12d3-a456-426614174000"
},
"script_version": {
"id": 1,
"author": {
"id": 1,
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"role": "admin",
"oidc_user_id": "text"
},
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"v_num": 1,
"code": "text",
"script": 1
},
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"status": "running",
"stdout": "text",
"stderr": "text",
"syserr": "text"
}
]Execute a test run of a response action script without saving to database. Useful for testing and debugging scripts before deployment.
The Python code to execute
Arguments to pass to the script (depends on trigger type)
Test run completed successfully
Bad request - missing required fields
No user on API key
Access denied
Script execution failed
System not ready for requests
POST /app/api/v1/response-actions/test HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"script_code": "text",
"trigger_args": {}
}{
"status": "text",
"stdout": "text",
"stderr": "text"
}List available response triggers for action creation
List of available triggers
Access denied
GET /app/api/v1/response-actions/triggers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-11-02T16:06:36.954Z",
"updated_at": "2025-11-02T16:06:36.954Z",
"trigger_tree_labels": [
"text"
],
"trigger_display_name": "text",
"trigger_fn_name": "text",
"trigger_arg_names": [
"text"
],
"script_var_names": [
"text"
],
"is_scriptable": true,
"is_runnable": true,
"display_index": 1,
"is_archived": true,
"parent": "123e4567-e89b-12d3-a456-426614174000"
}
]Last updated
Was this helpful?