NUnullplatform
Workflow aliases

Activate an alias

Changed on

Turns the alias on: every trigger on its revision registers, so cron schedules start firing, webhooks get a public URL, and event subscriptions are created. Until this call, a published workflow has zero side effects.

  • If any trigger fails to register, the response is still 200 but the alias rolls back to inactive: check failedTriggers for the reason.
  • latest cannot be activated. Create a named alias (for example live) first.
post/workflows/definitions/{id}/aliases/{alias}/activate

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/definitions/{id}/aliases/{alias}/activate
  • Auth
    HTTP bearer

Path parameters

idstring required

Workflow reference: a server-minted id (wf_...) or the workflow's client-chosen key (lowercase slug, unique per organization).

aliasstring required

The alias name. latest is reserved and auto-maintained.

Response

The activation outcome, including per-trigger results.

activatedTriggersstring[]

Example response

{
  "alias": {
    "workflowId": "wf_ifWBbWfpug0n",
    "name": "live",
    "revision": 3
  }
}

Changes