Documentation
  • Overview
  • How It Works
  • Developer API
    • Introduction
    • Initial Test
    • Setup
    • JS SDK
    • HTTPS API
      • Identity
      • Identity Status
      • Signal
    • Webhook
    • User Involvement
    • Bans
    • Boilerplates
      • Node.js
    • Types
      • Identity
      • Signal
      • Event
        • Type
        • Level
        • EventSignal
        • Recommendation
          • Ban
            • Action
          • Type
      • ImmediateResult
      • Identifiers
      • Device
      • Location
      • Carrier
      • IP
      • Tor
      • VPN
      • Approvable
Powered by GitBook
On this page
  1. Developer API
  2. Types
  3. Event

Recommendation

A Recommendation object contains data that articulates how to respond to an Event.

Attributes

  • type enum This recommendation's Type.

  • description string Instructions related to this recommendation in English language.

  • template string A pre-written message that you should pass onto the user.

    • Only present with type NOTIFY_USER or NOTIFY_USER_WITH_LINK.

  • ban Ban A Ban object.

    • Only present with type BAN_ACTION, BAN_DEVICE, or BAN_IP.

PreviousEventSignalNextBan

Last updated 2 years ago