Skip to navigation
aVenture APINews and ContentNews

Subscribe to Entity News

View as Markdown

Creates or refreshes a webhook subscription to news newly linked to one entity. A new endpoint must echo a signed verification challenge before the subscription exists.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Request

This endpoint expects an object.
argumentsobjectRequired
Arguments of the entity.news.published event.
deliveryobjectRequired
Webhook delivery target and secret.
nameenumRequired
Subscribable event name
Allowed values:
cursorstring or nullOptional

Opaque watermark from an earlier grant or event to resume after; null starts a new subscription from now and keeps an existing subscription's position.

ttlMslong or nullOptional>=1

Requested subscription lifetime in milliseconds; the server caps it.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
cursorstring
Opaque watermark the subscription delivers after.
idstring

Stable subscription id; sent as X-MCP-Subscription-Id.

refreshBeforedatetime
The subscription expires unless refreshed before this instant.
truncatedboolean
Whether events between the requested cursor and now were lost.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error