COcollectwise

Workflow status overview

Changed on

Provides workflow meta, totals, stage breakdown, window hours, SMS summary, and recent SMS for a workflow.

get/status/workflow/{workflowId}

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/status/workflow/{workflowId}
  • Auth
    API key in header collectwise_key

Path parameters

workflowIdstring required

Unique identifier of the workflow

Query parameters

hoursinteger

Lookback window in hours. Defaults to 24; clamped to [1, 8760].

datestring

Specific UTC day in YYYY-MM-DD format; when provided, supersedes the hours window.

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Response

Workflow status overview returned

object required

Changes

  • 95fad0d2f369Revision changes
    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp

    • info

      added the non-success response with the status