Skip to content

List workflow hook executions ​

GET/api/v2/workspaces/{slug}/projects/{project_id}/workflows/{workflow_id}/state-transitions/{transition_id}/hooks/{pk}/executions/

Return the runs of one hook as a paginated list, newest started_at first. Each row records the work item that moved, the run's status, what the handler received, and what it returned.

The history outlives the hook. After you delete a hook, its runs stay readable here. Plane checks only the transition in the path. An unknown hook id returns 200 with an empty list, not 404.

Path parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring

The project the workflow belongs to. Accepts the project UUID or its bare identifier, for example ENG.

workflow_id:requiredstring (uuid)

The workflow the transition belongs to.

transition_id:requiredstring (uuid)

The transition the hook is attached to. An unknown transition returns 404.

pk:requiredstring (uuid)

The id of the hook, including a deleted one.

Pagination ​

The order is fixed, newest started_at first. The phase, handler_name, is_enabled, and order_by parameters that the hook list takes have no effect here.

This list uses offset pagination only. ?paginate=cursor returns 400 ordering_not_cursor_eligible.

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Use the next value from the response instead of computing offsets yourself.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return on each row. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: completed_at, error_message, id, input_data, output_data, started_at, status, work_item_id.

See Sparse fields.

Scopes ​

projects.workflows:read

Errors ​

StatusCodeCause
400invalid_requestAn unknown name in fields.
400ordering_not_cursor_eligible?paginate=cursor. This list supports offset pagination only.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe Workflows feature isn't on your plan, or is turned off.
403forbiddenYour role or token scope can't read this project's workflows.
404not_foundNo such workspace, project, workflow, or transition, including a catalog transition in a governed workspace.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List workflow hook executions
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9e3f6a2c-7b14-4d8e-a5c1-2f60b8d4e719/state-transitions/5c8d2e71-4a9f-4b36-8e05-d17f3a6b9c42/hooks/3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69/executions/?per_page=20" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "e7b2c94a-1d58-4f36-b0a7-5c3e9d1f2a86",
      "work_item_id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
      "status": "failed",
      "started_at": "2026-01-15T14:08:12.338104Z",
      "completed_at": "2026-01-15T14:08:22.341927Z",
      "input_data": {
        "url_host": "hooks.example.com",
        "event_type": "workflow.transition",
        "phase": "post"
      },
      "output_data": {
        "delivery_id": "0b6f3e1c-8a24-4d97-9e5b-2c71f4a8d036",
        "status_code": 503,
        "response_body": "Service Unavailable",
        "duration_ms": 10003,
        "error": null
      },
      "error_message": "HTTP 503"
    },
    {
      "id": "4d91a6f2-7c3b-4e58-8a10-b6e2f9c5d473",
      "work_item_id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
      "status": "success",
      "started_at": "2026-01-14T10:02:47.912655Z",
      "completed_at": "2026-01-14T10:02:48.104382Z",
      "input_data": {
        "url_host": "hooks.example.com",
        "event_type": "workflow.transition",
        "phase": "post"
      },
      "output_data": {
        "delivery_id": "9a3d5f7b-2e16-4c84-b1f0-6d8e2a4c7b95",
        "status_code": 200,
        "response_body": "ok",
        "duration_ms": 191,
        "error": null
      },
      "error_message": ""
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

The execution object ​

FieldTypeMeaning
idstring (uuid)Unique identifier for the run.
work_item_idstring (uuid)The work item whose move triggered the run.
statusstringOne of pending, running, success, or failed.
started_atstring (date-time)When the run started. null while pending.
completed_atstring (date-time)When the run finished. null until it does.
input_dataobjectWhat the handler received. For send_webhook: url_host, event_type, and phase. For run_script: the transition event passed to the script.
output_dataobjectWhat the handler returned. For send_webhook: delivery_id, status_code, response_body, duration_ms, and error. For run_script: the script's output.
error_messagestringWhy the run failed, for example HTTP 503 for a webhook that got a non-2xx response. Empty when it succeeded.

A failed pre run blocks the transition. A failed post run is recorded here, and the move it followed stands.