PApaymongo
Workflows

Execute a workflow asynchronously

Queues a workflow execution request for asynchronous processing. Returns immediately with status 'queued'. Use GET /v1/instances to check execution status.

post/v1/workflows/{id}/run

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/workflows/{id}/run
  • Auth
    none required

Path parameters

idstring required

Workflow ID

Headers

Organization-Idstring required

Organization ID

Idempotency-Keystring required

Required. Unique per logical operation, and reused unchanged across every retry of that operation. Maximum 255 bytes, no whitespace or control characters, never trimmed.

Request body

inputobject

Workflow input data (JSON object, required and validated explicitly)

Example request

{
  "reference": {
    "external_id": "dp_abc123",
    "source": "disputes"
  }
}

Response

Workflow queued successfully

internalboolean

Whether execution is internal (superuser only)

livemodeboolean

Whether execution is in live mode

messagestring

Human-readable message

message_idstring

Queue message ID for tracking

queued_atstring

ISO 8601 timestamp when queued

statusstring

Execution status (always 'queued' for async execution)

workflow_idstring

ID of the workflow definition

Example response

{
  "livemode": true,
  "message": "Workflow queued for execution",
  "message_id": "msg_abc123",
  "queued_at": "2026-01-15 10:30:00+00:00",
  "status": "queued",
  "workflow_id": "flow_abc123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.