Update a workflow hook

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

Enable or disable a hook, or change its config. PATCH is partial. Send only the fields you want to change.

phase and handler_name are immutable. Sending either key, even with the current value, returns 400 invalid_request. To change when a hook runs or what it does, delete it and create a new one.

The response is the hook in its usual read shape. It never includes the webhook secret. Updating a hook adds a transition_rule entry to the workflow's activity.

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

Body parameters

Every field is optional. Send the subset you are changing.

is_enabled:optionalboolean

Turn the hook on or off. A disabled hook stays attached, but Plane skips it when the transition runs.

config:optionalobject

New settings for the hook's handler. How Plane combines them with the stored config depends on the handler.

For send_webhook:

• PATCH never changes the signing secret. Use Regenerate a workflow hook secret instead.
• Omit url to keep the stored URL.
• Omit headers to keep every stored header. When you send headers, the list replaces the stored list.
• In a headers list, you can omit value for a header with is_secret set to true, the default. That header keeps its stored value, provided a stored secret header has the same key. Keys match without regard to case. Every other header needs a value.

For run_script, Plane merges the keys you send over the stored config, so script_id stays unless you send a new one. A new script_id must be a system script, or a script in this workspace that is either workspace-wide or belongs to this project.

The same validation as create applies to the result.

execution_order is not writable

Plane assigns execution_order when it creates the hook. A PATCH that includes it succeeds, but Plane ignores the value.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. 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: config, created_at, execution_order, handler_name, id, is_enabled, phase, project_id, updated_at, workflow_transition_id.

See Sparse fields.

Scopes

projects.workflows:write

Errors

Status	Code	Cause
400	invalid_request	The body includes phase or handler_name, a header has no value and no stored secret to keep, or the resulting config fails validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The Workflows feature isn't on your plan, or is turned off.
402	payment_required	The hook's handler feature isn't on your plan, or is turned off: Plane Runner for run_script, Webhook transition conditions for send_webhook.
403	forbidden	Your role or token scope can't edit 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.
409	governance_migration_in_progress	A governance migration is running in this workspace, so writes are paused. Retry after it finishes.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Update a workflow hook

curl -X PATCH \
  "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" \
  -H "Content-Type: application/json" \
  -d '{
  "config": {
    "url": "https://hooks.example.com/plane/v2/transitions"
  }
}'

import requests

response = requests.patch(
    "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"},
    json={"config": {"url": "https://hooks.example.com/plane/v2/transitions"}},
)
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/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      config: { url: "https://hooks.example.com/plane/v2/transitions" },
    }),
  },
);
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/v2/transitions",
    "headers": [
      {
        "key": "X-Team",
        "value": "platform",
        "is_secret": false
      }
    ]
  },
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z"
}

Response400

{
  "type": "invalid_request",
  "code": "invalid_request",
  "detail": "`phase` is immutable after creation."
}