PApaymongo
Instances

Submit an external event to a waiting instance

Delivers an external event to a workflow instance that is paused on a wait_event step, resuming its execution.

post/v1/workflows/instances/{id}/events

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/workflows/instances/{id}/events
  • Auth
    HTTP basic

Path parameters

idstring required

Instance ID

Headers

Organization-Idstring required

Organization ID

Request body

event_namestring required
payloadobject
resolutionstring

Example request

{
  "event_name": "payment.paid",
  "resolution": "approved"
}

Response

Event submitted

Example response

{
  "data": {
    "event_name": "payment.paid",
    "instance_id": "inst_abc123",
    "processed_at": "2026-01-15 10:30:00+00:00",
    "status": "resumed",
    "step_index": 2
  }
}

Changes

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