Skip to content

List workspace workflow hook executions ​

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

Return the run history of one hook as a paginated list, newest first by started_at. Each row is one run, started by one work item's move through the transition. See the execution object.

After you delete a hook, its runs stay readable here. An unknown hook id returns an empty list rather than 404, but the workflow and transition in the path must exist.

The order is fixed, and the list has no filters. This list uses offset pagination only. ?paginate=cursor returns 400 ordering_not_cursor_eligible.

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.

workflow_id:requiredstring (uuid)

The catalog workflow the transition belongs to.

transition_id:requiredstring (uuid)

The transition the hooks run on. It must belong to the workflow in the path, or the request returns 404.

pk:requiredstring (uuid)

The id of the hook.

Pagination ​

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 ​

workspaces.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 view workspace workflows.
404not_foundNo such workflow in this workspace's catalog, or no such transition in it.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409states_managed_at_projectThe workspace doesn't have governance turned on. Use the project's workflows instead.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List workspace workflow hook executions
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/state-transitions/d7a3f5c9-0b2e-4d81-b6f4-9e1c3a5d7b20/hooks/e4b7c9a2-3d1f-4e68-8a52-9f0c6b3d7e15/executions/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "73c1e8f4-9a2b-4d56-b0e7-5f3a8c1d9e62",
      "work_item_id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
      "status": "success",
      "started_at": "2026-02-03T16:45:13.120554Z",
      "completed_at": "2026-02-03T16:45:13.482917Z",
      "input_data": {
        "url_host": "hooks.example.com",
        "event_type": "workflow.transition",
        "phase": "post"
      },
      "output_data": {
        "delivery_id": "c9e2b5f8-1a4d-4b73-8e06-7d3a9f2c5b18",
        "status_code": 200,
        "response_body": "ok",
        "duration_ms": 362,
        "error": null
      },
      "error_message": ""
    },
    {
      "id": "2b9e5d17-6c4a-4f83-9d21-8e0b3a7c5f49",
      "work_item_id": "6e2a9c4f-1b7d-4e35-8a90-3f5c7d2b1e84",
      "status": "failed",
      "started_at": "2026-02-02T10:12:40.904371Z",
      "completed_at": "2026-02-02T10:12:42.118036Z",
      "input_data": {
        "url_host": "hooks.example.com",
        "event_type": "workflow.transition",
        "phase": "post"
      },
      "output_data": {
        "delivery_id": "0d4b8f2e-6a1c-4e97-b3d5-8f2a6c1e9b40",
        "status_code": 503,
        "response_body": "Service Unavailable",
        "duration_ms": 1213,
        "error": null
      },
      "error_message": "HTTP 503"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}