Delete a workflow hook

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

Remove a hook from a transition. A successful delete returns 204 with an empty body, and the hook stops running on the next move.

The delete is soft. The hook drops out of the list and its own reads return 404, but its execution history stays readable at the same path. Deleting a hook adds a transition_rule entry with verb set to removed 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 delete.

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 request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The Workflows feature isn't on your plan, or is turned off.
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 is already 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.

Delete a workflow hook

curl -X DELETE \
  "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.delete(
    "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.status_code)

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: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}

Disable instead of deleting

To pause a hook without losing its place, send {"is_enabled": false} with Update a workflow hook. A deleted hook can't be restored, and a new hook gets a new id and a new secret.