Notify workflows waiting for an event

Stores an event for seven days and resumes one matching waiting run when present. Limited to 100 events/hour/workspace and 20 events/minute/event ID.

POST/api/v2/workflows/events/notify

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Request body

requiredapplication/json

eventIdstringrequired

min length 1 · max length 255

dataany

Optional event payload.

Responses

200

Event stored and optional waiting run resumed.

successbooleanrequired

Allowed:true

dataobjectrequired

Show properties

messagestringrequired

Allowed:Event deliveredEvent stored

notifiedRunIdstring | nullrequired

matches ^wfr_[A-Za-z0-9_-]{21}$

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.

Bodyapplication/json

eventIdstring*datastringOptional event payload.

Request

curl -X POST 'https://api.anlyon.com/api/v2/workflows/events/notify' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "eventId": "string",
  "data": null
}'

const response = await fetch("https://api.anlyon.com/api/v2/workflows/events/notify", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"eventId\": \"string\",\n  \"data\": null\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/workflows/events/notify",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"eventId\": \"string\",\n  \"data\": null\n}",
)

Response

{
  "success": true,
  "data": {
    "message": "Event delivered",
    "notifiedRunId": "string"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}