---
id: workflow-alias-activate
title: "Activate an alias"
description: "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."
sidebar_label: "Activate an alias"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zgW/isHfEniVeTsbBez0FvabYEsdnaCNEEHyARjWjyyOKFIlRc7HsP/fXFISbYTJel2XrpA8xJZIg/P5TsXfhvm+cKx4pZ9Mva+UmYFXEnu0LG7jAl0pZWtl0azgl0Hqx34GtMSMLoAXKJdg7dysUALRoP0DiwupZNGg8WFdB6ty8AZKK3R4MoaRVDowHluPVTSSr3IYIXz2ph7Bwv0wKENcyVLuLn6dwZcCzpHe3BhPijkgFuE0iL3KHK40V4q8LV0UHKlsl6Gq1HAqret5g7+QGvASYGAVYWld/mv+ld9ChcVcL2zpeJSOfBmMCKLplt0rdEOQZIFUin44ewM5sHvOcYapRzMeXlP+6XmpZdLLKCssbyHGUlGcZ3OcTOojO1Ec2d0TrrMFPfo/AxKrrXxMEeIQpKt76LRwEHzBkV36DGJwQfetAphpuQSZyfkXedzljHTouXktgvBCtb74zRuLXrRLGMtt7xBChkrbjdMUtxb7muWMTqMFUwKljGLn4O0KFjhbcCMUVQbzooN8+uWVjlPYWXbxxgaUGaxQou6xAI4OLRLtKeN1B4FSAHHs1X1W57nsxPonNOrfOSgVBK1Py1r41DDPa7hWJkV2pI7BKfCIoOg5eeA0BIm7YJr+Uc0/oRc0fmI3FD9JqtPb+efqjYszjTbZqMWRyf9GaOvB2SQxHwXXUm5Eo0XEeU8eHPacKk9lxrFobYUUra9y5jDMljp1zFCc+QW7XnwNStu7+hzj1BHmv1wdkb/RvRJMacsNcGXpsEMpC5VEFIvyHGnfSJYdEF5R8qURnvUniTytlWyjAKmvzsSu3nqEDP/HUtPsLIEQC+TUsmhtEz6aNp55+HH23Yevx0weyH6yND3VGhYxlKOsYyFVlCWnHsqYIfn7ol4ErSXcdFB4aVNKTx7Ou1WE6wXaPeX/207qLxbNzdGISdrHiVNjb5Gu6swR64vU6kK7moDabDzwIjClbEN96xgtObUywb3trxdj6K5Qc8F9yOR3WasU+SjJ0yPxf7Qlp94C6YaqqwUsUR6tw9IR7IIb1wISW+4ujwIZI+b672zR+BzGH2SGtxoEHVoCGItapHeqISlVKlZxvoazu76uP2vHhb4VdsUd/69tca+nlUNOscXIyjdUuKKsQ9bwmvQdNhPz8b4cQSv0gag1eBCWQNPU0EX0yMHs66b31g1y58ouvs4ptJzUaeau41/exHom+ieIG4tX1PIPDYj0abthw34C/Y+43E5Uke2GWtVWEh9HV+PfH4dhx3sCGv4KPa7yO1S7yoV6G/PjqEmf5lBXXDf/PLL05b1LvZ8iLtzoAY2N2INjq8drGruYUWfV9boRQFcp4Uwo0NmNAvWoeH61CIXfE7zkUDPpZrF4TKjuXXJlRSp/JC2waKj9wiovV2nSaKqUoGASqISLzTE1pq5wuYvI42xq1yXacVI0Xraqp3nWnArOqOi4cdXH97Bj/84+xG6syBZRJN2N084mD2n0+zkaVb60Tg/1ifWIqA1cHN1kQHmixxmtfetK6bTYa50a+exyQUup1Fpt/ukjT+tTNBidjjefJWM2ICSS1/qzf8xHob1T3A70p7fnL2JNZtc+pro3e1iJX1NHe3R/AD4IJ13dLbUFMzyFXUHQ91UYCV1rIZuOjKWJMeMZP5h1C5pytT+GZwXr+P8CwtJnJtfNs15bN3UlVxPS6Mr2Q0Yz7Su/a1NcB5qvqSLUhoLoTt9DUfU4I72q8jfx6rIjcaHFku6ZKQrR1dQvmfy90z+nsnfZCan60dtiLZojYuaRt2e8+1Giu2047Cmm/iwne4xHCnxE70RaAQd8MpbmeugVKu4p2k8L01zcOH+SMmf/LN/7R5MJUGs4wXifS4uYln38KGf8P/16TrOoVJXZr+U9OQIXYVJxxTys/yv+dkTILwNUoms57gysEEnpszMo4UDlomni+P5vmk7pKNeSI2RAvtgAl3IkKi9RJpgItTOLy+KxJFNJv/cuXoyiZfPfXYGhClDg9q7HN5HatBRmOdIBIMjxio0c6SATyb9RXkyieygNr4mpEoXSUVQxvk8nXmeotmdl0iv1lCy28jQ8R3jeKzk/UB/5XDeXSr1gobCxMHIbmL0kc6kq+dwl+7Yt8nk/QOWoTfSYmms6KjO6GeCPszX8X/WFQvdBk8jY/DpgWKhzMJ1Ej9iaZGuuVrAkltJYygJv0dsicUUqL3kKi1w6ElnR9LibblG2GE8XvIpFxoee1JHU3W24mDpY8xsdk3uO5f7f8zldtXG44OftorL2D9Cuk2n2rhjyxIIhpRlGSsigduT/BkreqwMNfIuYzVV2uKWbTZz7vDGqu2WXn8OaIl2vMtYj+FYR4V09CxYUXHl8AXcHV91Ff8EvgEqeNSTff/V1H2XXAX6xTJ2j+tEfxNN/FUW/xke+CtUTYHd0q27Ri7Qxlilb+dlia3f2/WEz6XGN3Tey58/XhNEDvvdo/4WxY+qtNmkFdfmHvV2O2jo6TdpuN3+F818UMQ=
sidebar_class_name: "post api-method"
info_path: docs/api/workflows
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Activate an alias"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/workflows/definitions/{id}/aliases/{alias}/activate"}
  context={"endpoint"}
>
  
</MethodEndpoint>



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.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"Workflow reference: a server-minted id (`wf_...`) or the workflow's client-chosen key (lowercase slug, unique per organization).","example":"wf_ifWBbWfpug0n"},{"in":"path","name":"alias","required":true,"schema":{"type":"string"},"description":"The alias name. `latest` is reserved and auto-maintained.","example":"live"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The activation outcome, including per-trigger results.","content":{"application/json":{"schema":{"type":"object","properties":{"alias":{"title":"Alias","type":"object","required":["workflowId","name","revision","active","updatedAt"],"properties":{"workflowId":{"type":"string","example":"wf_ifWBbWfpug0n"},"name":{"type":"string","example":"live"},"revision":{"type":"integer","example":3},"active":{"type":"boolean","description":"Whether the alias's triggers are activated."},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"metadata":{"type":"object"},"triggerStates":{"type":"object","description":"Map of trigger id to its activation state.","additionalProperties":{"title":"TriggerState","type":"object","properties":{"status":{"type":"string","enum":["pending","live","failed","inactive"]},"activatedAt":{"type":"string","format":"date-time"},"deactivatedAt":{"type":"string","format":"date-time"},"lastError":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}}},"runtimeMetadata":{"type":"object","description":"Runtime data such as the trigger's `webhookUrl`.","properties":{"webhookUrl":{"type":"string"}},"additionalProperties":true}}}}}},"activatedTriggers":{"type":"array","items":{"type":"string"}},"failedTriggers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"pluginType":{"type":"string"},"status":{"type":"string","enum":["failed"]},"error":{"type":"string"}}}},"triggerResults":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"pluginType":{"type":"string"},"status":{"type":"string","enum":["active","failed"]},"error":{"type":"string"}}}}}}}}},"4XX":{"description":"Client error. The body says what went wrong: an error `type`, a human-readable `detail`, and, on validation failures, one entry per offending field.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>
  
</StatusCodes>