CAcapy
automations

Flush batch

Changed on
post/api/v1/automations/{automationId}/batches/{batchId}/flush

Request

  • Base URL
    https://api.capy.ai
  • Auth
    HTTP bearer

Path parameters

automationIdstring required
batchIdstring required

Response

AutomationWebhookBatch

idstring required
automationIdstring required
triggerIdstring required
status'collecting' | 'queued' | 'cancelled' required

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

eventCountinteger required
byteCountinteger required
firstEventAtstring required
lastEventAtstring required
dispatchAfterstring required
maxEventsinteger required
maxWaitSecondsinteger required
quietPeriodSecondsinteger nullable required
closedAtstring nullable required
reason'count' | 'quiet' | 'max_wait' | 'bytes' | 'manual' | 'cancelled' | 'configuration_changed' | 'disabled' | 'project_deleted' required

The boundary that closed or cancelled a webhook batch.

runIdstring nullable required
runStatus'queued' | 'running' | 'completed' | 'failed' | 'skipped' | 'cancelled' nullable required
jamIdstring nullable required
failurestring nullable required

Changes

  • e3be47264febRevision changes
    • info

      added the non-success response with the status

  • 7187d2287ecdRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • info

      added to the response body anyOf list for the response status