Get a workflow hook

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

Retrieve one hook by id. The hook must be attached to the transition in the path, and that transition must belong to the workflow in the path. A deleted hook returns 404.

The response never includes the webhook signing secret. Only Create a workflow hook and Regenerate a workflow hook secret return it.

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.

pk:requiredstring (uuid)

The id of the hook.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. 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
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 hook, transition, workflow, project, or workspace. Also returned when the hook was deleted or the transition is in the catalog of 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.

Get a workflow hook

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/" \
  -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/3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

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/3b7e9a15-6c2d-4f84-9b31-0e5d8c7a2f69/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "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"
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "Not found."
}