PR Automations

Set or clear a PR-automation rule

put/api/workspaces/{workspaceId}/pr-automations

Request

  • Base URL: https://hiveship.app/api
  • URL: https://hiveship.app/api/api/workspaces/{workspaceId}/pr-automations
  • Auth: API key in cookie hiveship_access

Path parameters

workspaceIdstring required

Request body

event'PR_OPENED' | 'PR_MERGED' required
targetStatusIdstring nullable required

WorkflowStatus id to transition to, or null to clear the rule for this event.

Response

Rule upserted (or cleared if targetStatusId === null). The PUT is intentionally side-effect-only; clients refetch via GET /pr-automations if they need the new rule list.

successboolean required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.