Skip to content

AdminHook

A decision hook with its settings and the decisions of the period.

object
hook
required

A decision hook, where the server asks an external review before it accepts something: inbound.status (posts from other servers), inbound.follow (follows from other servers), signup.check (sign-ups), media.check (uploaded media), local.status (local posts), inbound.actor (profiles of accounts on other servers), local.profile (local profiles).

string
Allowed values: inbound.status inbound.follow signup.check media.check local.status inbound.actor local.profile
configured
required

Whether the hook has a plugin. A hook without one calls nothing, whatever its mode.

boolean
mode
required

How far a decision hook acts: off calls nothing, observe records the verdict and acts on nothing, enforce acts on the verdict.

string
Allowed values: off observe enforce
on_failure

What a hook that enforces does when its plugin fails: pass lets the subject through, retry fails the job so that it runs again, and require_approval holds the sign-up for approval.

string
Allowed values: pass retry require_approval
outcomes
required

The decisions per mode and outcome.

Array<object>

How many decisions of one mode and outcome a hook made, and how long they took.

object
mode
required

The mode of the hook when it made the decision.

string
Allowed values: observe enforce
outcome
required

What a decision records: a verdict (allow, drop, flag, mark_sensitive, require_approval, reject), or a kind of failure, which is not a verdict: timeout, error, invalid (the answer is outside the hook’s vocabulary), breaker_open (the server skipped the plugin after repeated failures).

string
Allowed values: allow drop flag mark_sensitive require_approval reject timeout error invalid breaker_open
count
required
integer format: int64
average_latency_ms
required
integer format: int64
max_latency_ms
required
integer format: int64

Example generated

{
"hook": "inbound.status",
"configured": true,
"mode": "off",
"on_failure": "pass",
"outcomes": [
{
"mode": "observe",
"outcome": "allow",
"count": 1,
"average_latency_ms": 1,
"max_latency_ms": 1
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site