tools.ozone.moderation.emitEvent

ozone-lexicons.bsky.social

Documentation

Take a moderation action on an actor.

main procedure

Take a moderation action on an actor.

Input

Encodingapplication/json
createdBy stringdid Required

A decentralized identifier (DID).

event union Required

No description available.

externalId string Optional

An optional external ID for the event, used to deduplicate events from external systems. Fails when an event of same type with the same external ID exists for the same subject.

reportAction ref#reportAction Optional

Optional report-level targeting. If provided, this event will be linked to specific reports and reporters may be notified.

subject union Required

No description available.

subjectBlobCids array Optional

No description available.

Output

Encodingapplication/json
Schematools.ozone.moderation.defs#modEventView

Errors

SubjectHasAction
DuplicateExternalId An event with the same external ID already exists for the subject.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Take a moderation action on an actor.",
  "errors": [
    {
      "name": "SubjectHasAction"
    },
    {
      "description": "An event with the same external ID already exists for the subject.",
      "name": "DuplicateExternalId"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "createdBy": {
          "format": "did",
          "type": "string"
        },
        "event": {
          "refs": [
            "tools.ozone.moderation.defs#modEventTakedown",
            "tools.ozone.moderation.defs#modEventAcknowledge",
            "tools.ozone.moderation.defs#modEventEscalate",
            "tools.ozone.moderation.defs#modEventComment",
            "tools.ozone.moderation.defs#modEventLabel",
            "tools.ozone.moderation.defs#modEventReport",
            "tools.ozone.moderation.defs#modEventMute",
            "tools.ozone.moderation.defs#modEventUnmute",
            "tools.ozone.moderation.defs#modEventMuteReporter",
            "tools.ozone.moderation.defs#modEventUnmuteReporter",
            "tools.ozone.moderation.defs#modEventReverseTakedown",
            "tools.ozone.moderation.defs#modEventResolveAppeal",
            "tools.ozone.moderation.defs#modEventEmail",
            "tools.ozone.moderation.defs#modEventDivert",
            "tools.ozone.moderation.defs#modEventTag",
            "tools.ozone.moderation.defs#accountEvent",
            "tools.ozone.moderation.defs#identityEvent",
            "tools.ozone.moderation.defs#recordEvent",
            "tools.ozone.moderation.defs#modEventPriorityScore",
            "tools.ozone.moderation.defs#ageAssuranceEvent",
            "tools.ozone.moderation.defs#ageAssuranceOverrideEvent",
            "tools.ozone.moderation.defs#ageAssurancePurgeEvent",
            "tools.ozone.moderation.defs#revokeAccountCredentialsEvent",
            "tools.ozone.moderation.defs#scheduleTakedownEvent",
            "tools.ozone.moderation.defs#cancelScheduledTakedownEvent"
          ],
          "type": "union"
        },
        "externalId": {
          "description": "An optional external ID for the event, used to deduplicate events from external systems. Fails when an event of same type with the same external ID exists for the same subject.",
          "type": "string"
        },
        "modTool": {
          "ref": "tools.ozone.moderation.defs#modTool",
          "type": "ref"
        },
        "reportAction": {
          "description": "Optional report-level targeting. If provided, this event will be linked to specific reports and reporters may be notified.",
          "ref": "#reportAction",
          "type": "ref"
        },
        "subject": {
          "refs": [
            "com.atproto.admin.defs#repoRef",
            "com.atproto.repo.strongRef"
          ],
          "type": "union"
        },
        "subjectBlobCids": {
          "items": {
            "format": "cid",
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "event",
        "subject",
        "createdBy"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "ref": "tools.ozone.moderation.defs#modEventView",
      "type": "ref"
    }
  },
  "type": "procedure"
}
reportAction object

Target specific reports when emitting a moderation event

Properties

all boolean Optional

Target ALL reports on the subject

ids array of integer Optional

Target specific report IDs

note string Optional

Note to send to reporter(s) when actioning their report

types array of string Optional

Target reports matching these report types on the subject (fully qualified NSIDs)

View raw schema 
{
  "description": "Target specific reports when emitting a moderation event",
  "properties": {
    "all": {
      "description": "Target ALL reports on the subject",
      "type": "boolean"
    },
    "ids": {
      "description": "Target specific report IDs",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "note": {
      "description": "Note to send to reporter(s) when actioning their report",
      "type": "string"
    },
    "types": {
      "description": "Target reports matching these report types on the subject (fully qualified NSIDs)",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Lexicon Garden

@