---
id: workflow-signal-send-by-correlation
title: "Send a signal by correlation key"
description: "Delivers a signal to the non-terminal execution of `workflowId` matching `correlationKey`. With `startIfMissing: true`, starts a new execution (using `startInputs`) when none is waiting."
sidebar_label: "Send a signal by correlation key"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zgM/iuEvlzbc16222EHf+vegO5wW9F26ICuuCgWHWuVJU+Uk+aC/PcDZTtxmqwF9ukOWL/UsSmSekg+IrUSQc5IpDfi2vm73LgFkJ5ZaUjcJkIhZV5XQTsrUvEGjZ6jJ5CtDAQHoUCwzg4C+lLzO7zHrOYV4HKYLFqtZ2oCpQxZoe0MJpnzHo1kqT9xORnCtQ4FTChIH87yvzSRtrMUgq9xkkB8zVYtLnrqj2qKyppVtqoDTY5hUaBlhxA0wULqoO1sKBLhKvTR4JkSqejcGjQbSQmtGkyXg55jIhGV9LLEgJ4BWgnNIFQyFCIRVpYo0uZfIjx+q7VHJVJ2ORGUFVhKka5EWFYsR8FrOxPrh5BeFdhhyarYUbyXZWV40VftZVpXSgZUYn3bmEEKr5xasu7M2YA28KOsKqOz6PfoK7Hq1b4TbvoVs7Dj7o3YDYVIxDZinAGVZ+CCRmos7gjv7W/P+/OLj+8Hz57/xjvvKX504SL/W+fXr6bXeVXPxpaXVnJpnIzrdvE79VMdvPRLeH/58QOoJkNRgaSYmS227foh65JGS/oQw3cgPB7nmnQDYPtR24Az9Px1N0F7MlPnDErOGYW5rE0QaS4N4WZNTM9Dsdjdz0VtQUdZqAkVOGuWTUo/zH5NTV0g7yr+JYIwq70Oy5itU5Qe/WkdCpHe3DbpQ5Wz1ITy+Xi8D2cvHReSenAeOb/nQWv+mJP2h1NxN782Bg9Ci7YuRXrDJXa75oxpPTmUUB3wB1V1eL34/Hkfg9dGow2A3js/BEZk6tQSSC4JFoUMsODPC++YoaRtBGHCJiYJSCjqUtqBR6nk1CBMFAapDX+yKgFnYS6NVhEfyKU2tUfi9whog19ChR5cnqNVzG65RqMeQbjybmqw/PUA0jrEcjpvJETyROrF2AdplfSq3VTc+NHFu9fw8o/xS2htQbMjSoDQz5tam3zPp0lMj90oN37sU8CuP2+jCywDny7OEsDhbAiTIoSK0tFoS+BLClgOFc5H0WnafrIuDHJXWzXZ5dUf0sEZ1UL6GHl9cAE28hRkqOkAlfRWvBi/iKcCQ/qUaujcggWfl1rBA64EvNcUiG1ry8HMnnB3s1EaKcy11Qw+jQ5QcANMT5v0Xi73onbukbg+Dud5+nSe64DlQaLczaF4DD++NQpY0YgyaUeZs7mOpFAikZw9gUpZU4BCzhG6kxJa60v4JXMKf2kpJLLI74dY5JPF+wqzgKqpEt8Sys9K/lnJPyv5P1nJUWcoHM8HlaPoafStj207HI1W3K6vBfdcXN3NgFB700tKWemhrY2pjAy58+Uwc2Vs47s27ZIrvAGh36xt9sOKRDtMxPYlComkfXjnfCmDSMX76yvB3nOVXmxHhLcdCvt9+4PmfLc332vAd3rmLcrbVnm83xnH7vdh87uO2Zy7Pql1YyeJRDCQTfKNh8+G472UfFVroxKo6qnRVCTgaxvbKnDTGIZNVRFnbZxMe/hvaw7tTFscfrFf7DtXe9AKJYHzM2n1Pwih0ASn52cpCwzg5OTNtqBOTkB6jLo36pTL6hJtoCG8naPnXnGOMMXMlRjH1rqcxi765KTD7OQkAXJgXYgDsSZAPiOMozBsbJ4y5NjZ42xTUDmmHU88d0vodMGR0XcIE26dJ8dDOM2Cnkuee7k9jaGLszD3rqH2lkAHguD1bMa6nG0tvu36aTbqMXN8esT9RJy5CGG6jP+TlrZiYBNwdWgeOBbGzajVeImZR57crYK59JobYlZ+h1hB5lGhDVqaRoAwsM/E2vjqgCHeMlkc3bgqSxlPx3b+vkSrttcR0yX0Mh3ucI/VekPz//s6o6WIgPdhVBmpI7NH/ukY9WZT1Fxa3aVOItII3W0iCua49EasVlNJ+Mmb9Zpff6vR8wR5m4guZpHclCZ+Vpva/i6wRxct1x7DgfuNg553J5HliM2lqfmXSMRdZKvo8ZpnvgKlQh/9aT69bqwOrljBduneELpOuhWnWYZVeFT2tncSnH+8vGLKbe9cSqd4jZcLZkC5aNx0EYXI5PHdShhpZ3U8nkSjk7lP7vL7Az6PuzoIxGrVSFy5O7Tr9QaXwL8ZmPX6X+Wh9c0=
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={"Send a signal by correlation key"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/workflows/signals/{name}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delivers a signal to the non-terminal execution of `workflowId` matching `correlationKey`. With `startIfMissing: true`, starts a new execution (using `startInputs`) when none is waiting.

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

<ParamsDetails
  parameters={[{"in":"path","name":"name","required":true,"schema":{"type":"string"},"description":"The signal name.","example":"jira:updated"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","required":["correlationKey","workflowId"],"properties":{"correlationKey":{"type":"string","example":"jira:PROJ-123"},"workflowId":{"type":"string","example":"wf_ifWBbWfpug0n"},"payload":{"description":"Arbitrary JSON delivered as the signal payload."},"aliasName":{"type":"string"},"revision":{"type":"integer"},"startIfMissing":{"type":"boolean","default":false},"startInputs":{"type":"object","description":"Run inputs used only when a new execution is started."}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The signal was delivered (or a new execution started).","content":{"application/json":{"schema":{"type":"object","properties":{"delivered":{"type":"boolean","enum":[true]},"executionId":{"type":"string"},"started":{"type":"boolean"}}}}}},"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>