Skip to main content

kobana inbox workflow-runs

Commands of kobana inbox workflow-runs. Every global option (Global options) applies here.

CommandHTTPDescription
workflow-runs listGET /v1/workflow-runsList workflow runs
workflow-runs getGET /v1/workflow-runs/{id}Get workflow run

workflow-runs list​

List workflow runs

kobana inbox workflow-runs list [OPTIONS]

GET /v1/workflow-runs

Keyset-paginated. Filters are typed query params (field=value, field[op]=value); unknown filters, unsortable fields and malformed values are rejected with 400 VALIDATION_ERROR. Steps are not embedded in the listing — GET /v1/workflow-runs/{id} returns them.

Query parameters

NameTypeRequiredDescription
limitintegerno
cursorstringnoOpaque cursor returned in meta.next_cursor of the previous page.
sort_bystringnoField to order by. Allowed: created_at, updated_at, status. Without it the order is created_at descending. Values: created_at, updated_at, status.
sort_orderstringnoasc (default) or desc. Needs sort_by. Values: asc, desc.
statusstringnoEquality. Also status[in]=a,b. Values: pending, running, success, failed.
email_idstringnoEquality. Also email_id[in]=a,b.
inbox_idstringnoEquality. Also inbox_id[in]=a,b.
agent_idstringnoEquality. Also agent_id[in]=a,b.
agent_run_idstringnoEquality. Also agent_run_id[in]=a,b.
created_atstringnoEquality. Also created_at[in]=a,b and created_at[gt|gte|lt|lte].
created_at[gte]stringno
created_at[lte]stringno
finished_atstringnoEquality. Also finished_at[in]=a,b and finished_at[gt|gte|lt|lte].
finished_at[gte]stringno
finished_at[lte]stringno

Headers

NameTypeRequiredDescription
x-origin-shared-secretstringnoShared secret between CloudFront and the origin. Required in production; ignored in development unless CF_ORIGIN_SHARED_SECRET is set.

Responses

HTTPDescription
200Page of results.
400Body failed Zod validation. error.details carries formErrors/fieldErrors.
404Resource not found or filtered out by soft-delete.

workflow-runs get​

Get workflow run

kobana inbox workflow-runs get [ID] [OPTIONS]

GET /v1/workflow-runs/{id}

The run with every step in execution order. Requests and responses are stored with secret values replaced by [REDACTED]; bodies are truncated to 4000 characters.

Path arguments: id

Headers

NameTypeRequiredDescription
x-origin-shared-secretstringnoShared secret between CloudFront and the origin. Required in production; ignored in development unless CF_ORIGIN_SHARED_SECRET is set.

Responses

HTTPDescription
200Success.
404Resource not found or filtered out by soft-delete.