Publish an event

Accept an event for asynchronous fan-out. Publishing to the reserved anlyon topic is blocked. idempotencyKey provides durable topic-scoped deduplication; Idempotency-Key protects an HTTP retry.

POST/api/v2/events

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

Idempotency-Keystring

Stable retry key for a mutation. The key is claimed atomically before the handler runs, so concurrent retries execute the side effect at most once. Replaying the key for the same request (same method, path, workspace and JSON body) returns the original response with an X-Idempotent-Replay: true header. Reusing the key for a different request returns 409 with error code idempotency_key_reuse. A duplicate arriving while the first is still in flight waits and then replays; if the first does not finish in time the duplicate gets 409 idempotency_request_in_progress. Keys are retained for 24 hours. Only successful (2xx) responses are stored; a failed request frees the key so it can be retried.

min length 1 · max length 255

Request body

requiredapplication/json

topicstringrequired

Public topic ID or name.

min length 1 · max length 100

typestringrequired

min length 1 · max length 200 · matches ^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)*$

dataobject

default: {}

idempotencyKeystring

Durable deduplication key scoped to the workspace and topic.

min length 1 · max length 255

runIdstring

Existing run in this API key environment for event-delivery spans.

max length 80

parentSpanIdstring

Optional parent span within runId.

max length 80

Responses

200

Original event returned because the body idempotency key was already used for this topic.

successbooleanrequired

Allowed:true

dataEventPublishResultrequired

Show properties

idstringrequired

matches ^evt_

statusstringrequired

Allowed:receivedfanned_outno_subscribers

deduplicatedboolean

True when a prior event with the same body idempotency key was returned.

202

Event accepted for asynchronous fan-out.

successbooleanrequired

Allowed:true

dataEventPublishResultrequired

Show properties

idstringrequired

matches ^evt_

statusstringrequired

Allowed:receivedfanned_outno_subscribers

deduplicatedboolean

True when a prior event with the same body idempotency key was returned.

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

402

Payment Required - Usage quota exceeded

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

404

Not Found - Resource does not exist

successbooleanrequired

requestIdstringrequired

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

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

409

The request conflicts with current resource state or a concurrent decision.

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

503

A required provider or platform dependency is not configured or available.

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.Idempotency-KeyheaderStable retry key for a mutation. The key is claimed atomically before the handler runs, so concurrent retries execute the side effect at most once. Replaying the key for the same request (same method, path, workspace and JSON body) returns the original response with an `X-Idempotent-Replay: true` header. Reusing the key for a different request returns `409` with error code `idempotency_key_reuse`. A duplicate arriving while the first is still in flight waits and then replays; if the first does not finish in time the duplicate gets `409 idempotency_request_in_progress`. Keys are retained for 24 hours. Only successful (2xx) responses are stored; a failed request frees the key so it can be retried.

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.anlyon.com/api/v2/events' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "topic": "string",
  "type": "order.completed",
  "data": {},
  "idempotencyKey": "string",
  "runId": "string",
  "parentSpanId": "string"
}'

const response = await fetch("https://api.anlyon.com/api/v2/events", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"topic\": \"string\",\n  \"type\": \"order.completed\",\n  \"data\": {},\n  \"idempotencyKey\": \"string\",\n  \"runId\": \"string\",\n  \"parentSpanId\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"topic\": \"string\",\n  \"type\": \"order.completed\",\n  \"data\": {},\n  \"idempotencyKey\": \"string\",\n  \"runId\": \"string\",\n  \"parentSpanId\": \"string\"\n}",
)

Response

{
  "success": true,
  "data": {
    "id": "string",
    "status": "received",
    "deduplicated": true
  }
}

{
  "success": true,
  "data": {
    "id": "string",
    "status": "received",
    "deduplicated": true
  }
}

{
  "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,
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "Daily message quota exceeded. Upgrade your plan to continue."
  }
}

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

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

{
  "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."
  }
}

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