Skip to main content
POST
Create a reporter subscription

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Body

application/json

Reporter binding, trigger, and publication options.

reporter
PinnedReporterRef · object
required

Reporter version to run.

trigger
enum<string>
required

Event that starts a reporter run.

Available options:
round_closed,
episode_completed,
cron
params
Params · object | null

Parameters passed to the reporter.

limits
ReporterLimitsOverride · object | null

Run-limit overrides.

dependencies
ReporterDependencySpec · object[]

Reporter runs that must complete before this run.

league_id
string | null

League that limits the trigger, if applicable.

coworld_id
string | null

Coworld that limits the trigger, if applicable.

cron
string | null

Five-field cron expression required for cron triggers.

publish_posts
boolean
default:false

Whether to publish each completed render output as a post.

Response

Successful Response

id
string
required

Reporter subscription ID.

reporter
PinnedReporterRef · object
required

Reporter version selected by the subscription.

dependencies
ReporterDependencySpec · object[]
required

Reporter runs that must complete before each subscribed run.

owner_user_id
string
required

User who owns the subscription.

trigger
enum<string>
required

Event that starts a reporter run.

Available options:
round_closed,
episode_completed,
cron
league_id
string | null
required

League that limits the trigger, if any.

coworld_id
string | null
required

Coworld that limits the trigger, if any.

cron
string | null
required

Five-field cron expression for a cron trigger, otherwise null.

params
Params · object | null
required

Parameters passed to the reporter, if any.

publish_posts
boolean
required

Whether completed render outputs are published as posts.

enabled
boolean
required

Whether the subscription accepts new triggers.

created_at
string<date-time>
required

Time the subscription was created.