List workspace workflow hooks

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

Return the hooks on one transition of a catalog workflow as a paginated list, enabled and disabled alike. Deleted hooks aren't listed.

Rows sort by execution_order by default. Each phase numbers its hooks from 1, so filter by phase to read one phase in run order.

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.

Query Parameters

Filters combine with AND.

phase:optionalstring

Return only pre or only post hooks. Any other value returns 400 invalid_request.

handler_name:optionalstring

Return only hooks with this handler, run_script or send_webhook. Plane doesn't validate the value, so an unknown value returns an empty list.

is_enabled:optionalboolean

Return only enabled (true) or only disabled (false) hooks.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

• execution_order, -execution_order: run order within each phase. execution_order is the default.
• created_at, -created_at
• id, -id

Only created_at and id are cursor-eligible. The cursor path rejects the default execution_order ordering with 400 ordering_not_cursor_eligible, so pair paginate=cursor with order_by=created_at.

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. Read the next value from the response rather than computing offsets yourself.

paginate:optionalstring

Set to cursor to opt into the COUNT-free keyset envelope, which returns next_cursor and has_more instead of next and total_count. Omit it for the default offset envelope.

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. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

Requestable here: config, created_at, execution_order, handler_name, id, is_enabled, phase, project_id, updated_at, workflow_transition_id.

See Sparse fields.

Scopes

workspaces.workflows:read

Errors

Status	Code	Cause
400	invalid_request	An unknown name in fields, or a phase other than pre or post.
400	ordering_not_cursor_eligible	paginate=cursor with an order_by that isn't cursor-eligible, including the default.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Workflows isn't on your plan, or is switched off.
403	forbidden	Your role or token scope can't view workspace workflows.
404	not_found	No such workflow in this workspace's catalog, or no such transition in it.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	states_managed_at_project	The workspace doesn't have governance turned on. Use the project's workflows instead.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List workspace workflow hooks

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/?phase=post" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/state-transitions/d7a3f5c9-0b2e-4d81-b6f4-9e1c3a5d7b20/hooks/",
    headers={"X-Api-Key": "your-api-key"},
    params={
        "phase": "post",
    },
)
print(response.json())

const params = new URLSearchParams({
  phase: "post",
});
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/state-transitions/d7a3f5c9-0b2e-4d81-b6f4-9e1c3a5d7b20/hooks/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "e4b7c9a2-3d1f-4e68-8a52-9f0c6b3d7e15",
      "workflow_transition_id": "d7a3f5c9-0b2e-4d81-b6f4-9e1c3a5d7b20",
      "project_id": null,
      "phase": "post",
      "handler_name": "send_webhook",
      "is_enabled": true,
      "execution_order": 1,
      "config": {
        "url": "https://hooks.example.com/plane",
        "headers": [
          {
            "key": "X-Team",
            "value": "platform",
            "is_secret": false
          }
        ]
      },
      "created_at": "2026-01-15T11:04:52.660219Z",
      "updated_at": "2026-01-15T11:04:52.660219Z"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 1,
  "pagination": {
    "style": "offset"
  }
}