Publish to all endpoints in a group

Send a message to all endpoints in a URL group. Fan-out is a publish, so it obeys the same rules as POST /messages/publish: the messages are created in the calling key’s environment, a halted environment refuses an agent key’s publish with 409, and a {{secret:NAME}} reference in a delivery header requires secrets:read.

Against a key budget the publish costs one unit per endpoint in the group, and admission is all-or-nothing: a fan-out that does not fit the remaining cap is refused whole with 429 BUDGET_EXCEEDED and no endpoint receives a message.

POST/api/v2/url-groups/{groupId}/publish

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.

Path parameters

groupIdstringrequired

The URL group ID

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

methodstring

default: "POST"

Allowed:GETPOSTPUTPATCHDELETE

headersobject

bodyany

Request body

queuestring

matches ^[a-zA-Z0-9_-]+$

executeAtinteger<int64>

min 0

scheduledForstring<date-time>deprecated

maxRetriesinteger

min 0 · max 10 · default: 3

contentIdstring

Optional 24-hour content-deduplication identifier.

callbackUrlstring<uri>

failureCallbackUrlstring<uri>

runIdstring

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

max length 80

parentSpanIdstring

Optional parent span within runId.

max length 80

flowControlobject

Show properties

keystringrequired

min length 1 · max length 100 · matches ^[a-zA-Z0-9_-]+(?::[a-zA-Z0-9_-]+)*$

rateLimitinteger

min 1 · max 10000

rateLimitWindowinteger

min 1 · max 3600

parallelisminteger

min 1 · max 1000

Responses

200

Messages published to group successfully

successboolean

dataPublicUrlGroupPublishResult

Show properties

publishedCountintegerrequired

min 0

failedCountintegerrequired

min 0

messagesobject[]required

Show properties

Array of object

messageIdstringrequired

matches ^msg_

endpointUrlstring<uri>required

failuresobject[]required

Show properties

Array of object

urlstring<uri>required

errorstringrequired

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.groupIdpath*The URL group ID

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.anlyon.com/api/v2/url-groups/string/publish' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "method": "GET",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "body": null,
  "queue": "string",
  "executeAt": 0,
  "scheduledFor": "2019-08-24T14:15:22Z",
  "maxRetries": 3,
  "contentId": "string",
  "callbackUrl": "http://example.com",
  "failureCallbackUrl": "http://example.com",
  "runId": "string",
  "parentSpanId": "string",
  "flowControl": {
    "key": "string",
    "rateLimit": 1,
    "rateLimitWindow": 1,
    "parallelism": 1
  }
}'

const response = await fetch("https://api.anlyon.com/api/v2/url-groups/string/publish", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"method\": \"GET\",\n  \"headers\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  },\n  \"body\": null,\n  \"queue\": \"string\",\n  \"executeAt\": 0,\n  \"scheduledFor\": \"2019-08-24T14:15:22Z\",\n  \"maxRetries\": 3,\n  \"contentId\": \"string\",\n  \"callbackUrl\": \"http://example.com\",\n  \"failureCallbackUrl\": \"http://example.com\",\n  \"runId\": \"string\",\n  \"parentSpanId\": \"string\",\n  \"flowControl\": {\n    \"key\": \"string\",\n    \"rateLimit\": 1,\n    \"rateLimitWindow\": 1,\n    \"parallelism\": 1\n  }\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/url-groups/string/publish",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"method\": \"GET\",\n  \"headers\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  },\n  \"body\": null,\n  \"queue\": \"string\",\n  \"executeAt\": 0,\n  \"scheduledFor\": \"2019-08-24T14:15:22Z\",\n  \"maxRetries\": 3,\n  \"contentId\": \"string\",\n  \"callbackUrl\": \"http://example.com\",\n  \"failureCallbackUrl\": \"http://example.com\",\n  \"runId\": \"string\",\n  \"parentSpanId\": \"string\",\n  \"flowControl\": {\n    \"key\": \"string\",\n    \"rateLimit\": 1,\n    \"rateLimitWindow\": 1,\n    \"parallelism\": 1\n  }\n}",
)

Response

{
  "success": true,
  "data": {
    "publishedCount": 1,
    "failedCount": 1,
    "messages": [
      {
        "messageId": "msg_1234567890abcdef",
        "endpointUrl": "https://example.com/webhook"
      }
    ],
    "failures": [
      {
        "url": "https://unavailable.example.com/webhook",
        "error": "Destination temporarily unavailable"
      }
    ]
  }
}

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