Submit a workflow event

Injects an event into the workflow runtime, correlating it to waiting runs by event name and correlation key.

RBAC · workflow

Request body

Content type: application/json · schema WorkflowEventBody

eventNamestringRequired

workflowCorrelationKeystring

correlationKeystring

payloadSchemaRefstring

payloadobject

Response body

Success response 200 · schema UnversionedV1Success

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Event accepted.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

500

Unexpected error.

POST /api/workflow/events

cURL

curl -X POST "https://algapsa.com/api/workflow/events" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "eventName": "string",
  "workflowCorrelationKey": "string",
  "correlationKey": "string",
  "payloadSchemaRef": "string",
  "payload": {}
}'

TypeScript

const response = await fetch("https://algapsa.com/api/workflow/events", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "eventName": "string",
    "workflowCorrelationKey": "string",
    "correlationKey": "string",
    "payloadSchemaRef": "string",
    "payload": {}
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/workflow/events");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""eventName"": ""string"",
  ""workflowCorrelationKey"": ""string"",
  ""correlationKey"": ""string"",
  ""payloadSchemaRef"": ""string"",
  ""payload"": {}
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}