headless lms
Automations

List an automation's runs (staff)

GET /api/automations/{id}/runs. List an automation's runs (staff). Headless LMS Automations API reference.

GET
/api/automations/{id}/runs

Staff only (owner, admin, instructor). A deleted automation's runs remain reachable as an audit trail, so an unknown id answers an empty page rather than 404. A run's event carries the fields a webhook delivery of that event would.

Path Parameters

id*string

Query Parameters

page?integer
Range1 <= value <= 9007199254740991
Default1
pageSize?integer
Range1 <= value <= 100
Default20
search?string
Lengthlength <= 200
sort?string
status?string

Value in

  • "running"
  • "completed"
  • "failed"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/automations/string/runs"
{  "rows": [    {      "orgId": "string",      "id": "string",      "automationId": "string",      "trigger": "string",      "eventId": "string",      "event": {        "type": "string",        "version": 1,        "id": "string",        "orgId": "string",        "occurredAt": "string",        "data": null,        "metadata": {          "property1": null,          "property2": null        }      },      "status": "running",      "actionResults": [        {          "index": 0,          "type": "string",          "status": "completed",          "error": "string",          "recipients": [            "string"          ]        }      ],      "startedAt": "2019-08-24T14:15:22Z",      "finishedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}

Delete a workflow automation (staff) DELETE

DELETE /api/automations/{id}. Delete a workflow automation (staff). Headless LMS Automations API reference.

Run a finished run again (staff) POST

POST /api/automations/{id}/runs/{runId}/rerun. Run a finished run again (staff). Headless LMS Automations API reference.