NUnullplatform
Workflow aliases

Create an alias

Changed on

Creates an alias pointing at an existing revision. latest is reserved. Creating an alias does not activate its triggers; call the activate endpoint for that.

post/workflows/definitions/{id}/aliases

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/definitions/{id}/aliases
  • 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).

Request body

namestring required
revisioninteger required

Example request

{
  "name": "live",
  "revision": 3
}

Response

The alias was created.

workflowIdstring required
namestring required
revisioninteger required
activeboolean required

Whether the alias's triggers are activated.

updatedAtstring date-time required
updatedBystring
metadataobject
triggerStatesobject

Map of trigger id to its activation state.

Example response

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

Changes