Skip to main content
POST
Create subscription

Authorizations

Authorization
string
header
required

API key, not necessarily a JWT. Server derives Organization, permitted actions and Corpus scope; every resource access is authorized.

Body

application/json

Create enabled from-now Subscription. An optional owner makes it the Subscription of one end user of the client application; without one it is global to the Organization. The owner is fixed for the Subscription's life and part of the idempotent request. An optional deployment-configured destination per version belongs to this Organization. Omit destination_id to record Matches and change-feed notices without creating Deliveries or sending webhooks. URL and signing key are provisioned outside this API and not returned. No inline secret or dynamic destination registry in the tracer.

idempotency_key
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
saved_query_id
string
required
Minimum string length: 1
saved_query_version_id
string
required
Minimum string length: 1
evaluator
object
required

Pins an installed evaluator by plugin id and version, and its configuration. Evaluators are the subscription Contributions of the plugins pinned at startup (Plugin Protocol v0). The configuration must satisfy the evaluator's declared configuration schema.

destination_id
string
Minimum string length: 1
owner
string

Subscription Owner, an opaque end-user reference defined by the client application (for example user-123). Quivr stores, filters and echoes it without interpreting it. At most 128 characters without control characters; none is reserved for the listing filter. A refused owner is 422 invalid_owner, in a creation body as in the listing filter.

Required string length: 1 - 128

Response

Successful response

Absent owner means a global, organization-wide Subscription.

subscription_id
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
enabled
boolean
required
deleted
boolean
required

Logically deleted for good; a deleted Subscription is also disabled and stays readable with its Versions, Matches and Deliveries.

current_version
object
required

Immutable Subscription configuration. Every Version keeps the Subscription's owner, absent for a global Subscription. destination_id is absent when this Version records Matches and change-feed notices without webhook delivery.

owner
string

Subscription Owner, an opaque end-user reference defined by the client application (for example user-123). Quivr stores, filters and echoes it without interpreting it. At most 128 characters without control characters; none is reserved for the listing filter. A refused owner is 422 invalid_owner, in a creation body as in the listing filter.

Required string length: 1 - 128