List workflow hooks

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

Return the hooks attached to one workflow transition as a paginated list, sorted by execution_order. Deleted hooks are not listed.

Reads never include the webhook signing secret. In a governed workspace, transitions live in the workspace catalog and this route returns 404 for them. Use Workspace workflow hooks there.

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 whose hooks you want. A transition that is not part of this workflow in this project returns 404.

Query Parameters

Filters combine with AND. A phase other than pre or post returns 400 invalid_request instead of an empty list.

phase:optionalstring

Return only hooks in this phase. One of pre or post.

handler_name:optionalstring

Return only hooks with this handler, for example send_webhook or run_script.

is_enabled:optionalboolean

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

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

• execution_order, -execution_order. The default is execution_order.
• created_at, -created_at
• id, -id

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. 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.

Cursor pagination needs order_by set to created_at or id, with or without -. With the default execution_order ordering, ?paginate=cursor returns 400 ordering_not_cursor_eligible.

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

projects.workflows:read

Errors

Status	Code	Cause
400	invalid_request	A phase outside pre and post, or an unknown fields name.
400	ordering_not_cursor_eligible	?paginate=cursor with an ordering other than created_at or id.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Workflows aren't enabled on your plan.
403	forbidden	Your role or token scope can't read this project's workflows.
404	not_found	No such workspace, project, workflow, or transition, including a catalog transition in a governed workspace.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List workflow hooks

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

import requests

response = requests.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/",
    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/projects/4af68566-94a4-4eb3-94aa-50dc9427067b" +
    "/workflows/9e3f6a2c-7b14-4d8e-a5c1-2f60b8d4e719" +
    `/state-transitions/5c8d2e71-4a9f-4b36-8e05-d17f3a6b9c42/hooks/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69",
      "workflow_transition_id": "5c8d2e71-4a9f-4b36-8e05-d17f3a6b9c42",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "phase": "post",
      "handler_name": "send_webhook",
      "is_enabled": true,
      "execution_order": 1,
      "config": {
        "url": "https://hooks.example.com/plane/transitions",
        "headers": [
          {
            "key": "X-Team",
            "value": "platform",
            "is_secret": false
          }
        ]
      },
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z"
    },
    {
      "id": "6e1a4c8d-2f97-4b53-a0d6-9c3e7b15f824",
      "workflow_transition_id": "5c8d2e71-4a9f-4b36-8e05-d17f3a6b9c42",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "phase": "post",
      "handler_name": "run_script",
      "is_enabled": false,
      "execution_order": 2,
      "config": {
        "script_id": "d82f5b4e-7a13-4c69-9e0b-3f6a1c8d2e57",
        "execution_variables": {
          "channel": "releases"
        }
      },
      "created_at": "2026-01-14T09:31:07.215846Z",
      "updated_at": "2026-01-15T11:04:52.630194Z"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "id": "3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69",
      "workflow_transition_id": "5c8d2e71-4a9f-4b36-8e05-d17f3a6b9c42",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "phase": "post",
      "handler_name": "send_webhook",
      "is_enabled": true,
      "execution_order": 1,
      "config": {
        "url": "https://hooks.example.com/plane/transitions",
        "headers": []
      },
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z"
    }
  ],
  "next_cursor": "b3A9MTcx",
  "has_more": true,
  "pagination": {
    "style": "cursor"
  }
}

execution_order is per phase

pre and post hooks number their execution_order separately, so a transition can have a pre hook and a post hook that both have execution_order 1. Filter by phase to see the run order of one phase.