CHcheckout
Workflows

Get action invocations

Get the details of a workflow action executed for the specified event.

get/workflows/events/{eventId}/actions/{workflowActionId}

Request

Path parameters

eventIdstring required

The event identifier

workflowActionIdstring required

The workflow action identifier

Response

Workflow action retrieved successfully

workflow_idstring

The workflow identifier

event_idstring

The unique event identifier.

workflow_action_idstring

The worklow action identifier.

action_typestring

The workflow action type.

status'pending' | 'successful' | 'failed'

The status of the workflow action. It aggregates the past invocations outcome.

Example response

{
  "workflow_id": "wf_c7svxlvo2bbuva4f6s3xu4f7wm",
  "event_id": "evt_az5sblvku4ge3dwpztvyizgcau",
  "workflow_action_id": "wfa_uzkxpffkvpiu5fe3h5ira7sqpa",
  "action_type": "webhook",
  "status": "successful",
  "action_invocations": [
    {
      "invocation_id": "ivc_az5sblvku4ge3dwpztvyizgcau",
      "timestamp": "2019-05-23T08:26:59.0000000+00:00",
      "retry": false,
      "succeeded": true,
      "final": true,
      "result_details": {
        "status_code": 200,
        "url": "https://example.com/webhooks",
        "headers": {
          "Authorization": "<AUTHORIZATION_UUID>"
        },
        "response_received_timestamp": "2019-05-23T08:27:01.0000000+00:00"
      }
    },
    {
      "invocation_id": "ivc_az5sblvku4ge3dwpztvyizgcau",
      "timestamp": "2019-05-23T08:27:01.0000000+00:00",
      "retry": true,
      "succeeded": false,
      "final": false,
      "result_details": {
        "status_code": 500,
        "url": "https://example.com/webhooks",
        "headers": {
          "Authorization": "<AUTHORIZATION_UUID>"
        },
        "response_received_timestamp": "2019-05-23T08:27:01.0000000+00:00"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/events/evt_az5sblvku4ge3dwpztvyizgcau/actions/wfa_uzkxpffkvpiu5fe3h5ira7sqpa"
    }
  }
}

Changes

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