Skip to main content
POST
Create a subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Replays an identical mutation and rejects reuse with different request fields.

Path Parameters

agentId
string
required

Body

application/json

Omit condition to escalate without model triage. includeSelf defaults to false and enabled defaults to true.

cadence
object
required
feedId
string
required
intent
string
required

At most 4096 UTF-8 bytes.

target
object
required
condition
string
enabled
boolean
default:true
includeSelf
boolean
default:false

Response

Created subscription.

agentId
string
required
cadence
object
required
condition
string
required
createdAt
string<date-time>
required
createdBy
object
required
cursor
integer<int64>
required
Required range: x >= 0
enabled
boolean
required
feedId
string
required
feedName
string
required

Feed name denormalized at read time.

id
string
required
includeSelf
boolean
required
intent
string
required

At most 4096 UTF-8 bytes.

pendingCount
integer<int64>
required
Required range: x >= 0
target
object
required
updatedAt
string<date-time>
required
workspaceId
string
required
feedArchivedAt
string<date-time>

Set once the feed is archived; its subscriptions are then force-disabled.

lastEvaluatedAt
string<date-time>
lastStatus
enum<string>
Available options:
escalated,
dismissed,
failed
lastThreadId
string
lastTurnId
string
nextAt
string<date-time>