Skip to main content
POST
Cancel batch

Authorizations

Authorization
string
header
required

An API key created in Capy under Settings → API.

Path Parameters

automationId
string
required
batchId
string
required

Response

AutomationWebhookBatch

id
string
required
automationId
string
required
triggerId
string
required
status
enum<string>
required

Collecting accepts events; queued has one automation run; cancelled retains scrubbed history without a run.

Available options:
collecting,
queued,
cancelled
group
(string | number | boolean)[]
required

A non-null finite JSON scalar; string, number, and boolean grouping values remain distinct.

eventCount
integer
required
byteCount
integer
required
firstEventAt
string
required
lastEventAt
string
required
dispatchAfter
string
required
maxEvents
integer
required
maxWaitSeconds
integer
required
quietPeriodSeconds
integer | null
required
closedAt
string | null
required
reason
enum<string> | null
required

The boundary that closed or cancelled a webhook batch.

Available options:
count,
quiet,
max_wait,
bytes,
manual,
cancelled,
configuration_changed,
disabled,
project_deleted
runId
string | null
required
runStatus
enum<string> | null
required
Available options:
queued,
running,
completed,
failed,
skipped,
cancelled
jamId
string | null
required
failure
string | null
required