---
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: >-
  eJztV99v2zYQ/lcOfGmKyT/adeigt7RrgXRYGiQpUiAIprN4sthIpEZSdgTD//twlGxLsZoAfdqA5iWySB6/++67091GeFw6Ed+KG2Pvs8KswamlxsKJu0hIcqlVlVdGi1j8QYVakXWA3R7wBnxOoI2eeLKl4nf0QGnNJ8BkkKw7q2cygRJ9miu9hCQ11lKBvOtPapIp3CifQ+I8Wn+W/aWcU3oZg7c1JRGE13yrpnXP/EntgrH2lK5q75KXsM5JMyAC5WCNyiu9nIpImIpsuPBMiljsYE1aR2JHWk4WzaQHTESiQoslebJM0EYoJqFCn4tIaCxJxO2/SFj6p1aWpIgZciRcmlOJIt4I31S8z3mr9FJsH1N6ndOOSzbFQOkBy6rgQ9+UxbiuJHqSYnvXXkPOvzOyYdup0Z6050esqkKlAffsm2PTm2MQZvGNUj+AeyuGoRCROESMFVBZJs4rcu2Ng81H/h2hv7j8/Gny6vWv7HnP8JMH19nfKrt5t7jJqno513y0wqYwGM4N+Tu1C+Ut2gY+XX0+B9kqlCSgC8rsuO3OT9kWFgrdeQjfSHgsrZRTLYHdotKelmR5dSjQ3p6FMQUha0ZShnXhRZxh4Wh/JshzLBZDfy5rDSrshdqRBKOLppX0Y/Ur1+YFsVfhLxKO0toq3wS1Lggt2dPa5yK+vWvl4yqjXRvK1/P5MZ09Oa7R9eg8MfYIQXf9SxbtD0txqK/9haPUkq5LEd9yit1tWTEdkjFB7YgfNbXj683Xr8ccvC8UaQ9krbFTYEYWRjbgsHGwztHDmpfX1nCFQt1uhISvSCJAyOsS9cQSSlwUBIkkj6rgJS0jMBpWWCgZ+IEMVVFbcvyegLS3DVRkwWQZacnVLVNUyCcYrqxZFFT+MsK08iGdLtodInpGeiH2HrVEKzunguMnlx/fw9vf52+huwtaj1wEjuyqzbXke5iSII9hlFscxyVgiOdDgMB74MvlWQQ0XU4hyb2vXDybHQp44zyVU0mrWQDtDkva+Elmai2TYV39IRusqI7Sp4rXufGw3+88+tqNlJLeiTfzN+GrwJQ+Zxp2sGDN30sl4VGtBHpQzju+W2kOZvoM3L2jbiYpU1ox+W42UoJbYnrW0FpsjqJ2YclxfozrPH5e58pTOVoohxoKn+GnXXOeKjdzKepZanSmQlEoyTlcPsNKWTsPOa4Idl9K6G5v4EVqJL3oSkioIr+NVZEvmh4qSj3JNktsV1B+ZvLPTP6Zyf/JTA42fW54PqiMC0gDtj633XA023C7vhXcc3F2twNCbYueKLFSU10XRVWgz4wtp6kpQxu/a9OuOMNbEvrN2t4fNiS6YSK0L2GTiLqHj8aW6EUsPt1cC0bPWXp5GBE+7Fg47tsfNefD3vyoAR/0zAeWD63y/LgzDt3v4+Z3G9ScGYbEpLVCezWdT+din5PivMcZnF6chQHAOF9iqIvd5HVFWh4G0UUDPR/hno703BuX/t+DbCcOTw9+VhWoQk4H5e1y6XYfTsfy6cb5SMSBurtI5Kzu+FZsNgt09MUW2y2//qcmy7PDXSRWaBW3r0HWUjl+lvuofpfYk8suy17CyGQ7inxXgzRHbIVFzb9EJO6DTgPiLXf7OaEkG/C0S+/bWyfXbOBw9Gj82Ea7E6dpSpV/cu9drwZcfL665mTrpu3SSD5jcc3ax3UL0wQWQg6HdxtRoF7WoTCJ1iarHoeZ/SiTg1ejRGw27Y5rc096u93z4vk3E7Pd/gsH4z0J
sidebar_class_name: post api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/workflow-signal-send-by-correlation'
---
<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>