moderation_api 2.33.0 → 2.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294b476a6ef6e1b027a65e8b2597d4309b42561044836e8c36a227634f0f6534
-  data.tar.gz: 0fe19f2530860dd03131a9bd64f226d089b69a2dec0f0431126352cb69808bc4
+  metadata.gz: 58efdd27a36bd37a1e9b27e916fe3591f4ad21e43f3dac943a48cdee701f84e5
+  data.tar.gz: cb32bc627ec56cc42a6c0831ef68a25da57a591695662f30c6177799d34e252e
 SHA512:
-  metadata.gz: da98eb385747ee416b4a21a58092e5fe19e5620af0cc29e006e932ba2a07413ccc8cfec0005d000bd073ef3ccaa8d645bb515982eaf89ac7983791d220f076ff
-  data.tar.gz: 8d98d957d5ffe79a5fd31f06052837a33f8780ac43b88be9680bab1415655b2b9eb28a8151f2a10526ccda134a9f5c44eb500e3352f2db1edd6c1352df018ea2
+  metadata.gz: ef3456ebe2958f141802fd4d6e46dc1ce03ad95805d5158658b0c1a6cd3aca172a659c4d8758f0737ca1f3a65d9727c84d138f403af835618f6e817a712162b8
+  data.tar.gz: 703455e6b65df299a0b01e4ee53bb51ab68e25e7d4188025d467d6200c529261bd49171ed5eecdaa1c9dedac41f4a012f16809c4a5f5daf45268ce20b57c2cfd

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 2.35.0 (2026-08-21)
+
+Full Changelog: [v2.34.0...v2.35.0](https://github.com/moderation-api/sdk-ruby/compare/v2.34.0...v2.35.0)
+
+### Features
+
+* **api:** api update ([ce30b48](https://github.com/moderation-api/sdk-ruby/commit/ce30b48c33ec082b8143b3af082d07de83c44a3d))
+
+## 2.34.0 (2026-08-20)
+
+Full Changelog: [v2.33.0...v2.34.0](https://github.com/moderation-api/sdk-ruby/compare/v2.33.0...v2.34.0)
+
+### Features
+
+* **api:** webhooks and stream ([ff603e8](https://github.com/moderation-api/sdk-ruby/commit/ff603e825cf163e821282148124e784545618518))
+
 ## 2.33.0 (2026-08-14)
 
 Full Changelog: [v2.32.0...v2.33.0](https://github.com/moderation-api/sdk-ruby/compare/v2.32.0...v2.33.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "moderation_api", "~> 2.33.0"
+gem "moderation_api", "~> 2.35.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/moderation_api/client.rb

@@ -39,6 +39,12 @@ module ModerationAPI
     # @return [ModerationAPI::Resources::Wordlist]
     attr_reader :wordlist
 
+    # @return [ModerationAPI::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # @return [ModerationAPI::Resources::WebhookSecret]
+    attr_reader :webhook_secret
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -48,6 +54,11 @@ module ModerationAPI
       {"authorization" => "Bearer #{@secret_key}"}
     end
 
+    # @api private
+    #
+    # @return [Boolean]
+    def base_url_overridden? = @base_url_overridden
+
     # Creates and returns a new client for interacting with the API.
     #
     # @param secret_key [String, nil] Defaults to `ENV["MODAPI_SECRET_KEY"]`
@@ -70,6 +81,8 @@ module ModerationAPI
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
+      @base_url_overridden = !base_url.nil?
+
       base_url ||= "https://api.moderationapi.com/v1"
 
       if secret_key.nil?
@@ -107,6 +120,8 @@ module ModerationAPI
       @account = ModerationAPI::Resources::Account.new(client: self)
       @auth = ModerationAPI::Resources::Auth.new(client: self)
       @wordlist = ModerationAPI::Resources::Wordlist.new(client: self)
+      @webhooks = ModerationAPI::Resources::Webhooks.new(client: self)
+      @webhook_secret = ModerationAPI::Resources::WebhookSecret.new(client: self)
     end
   end
 end

data/lib/moderation_api/models/content_stream_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Content#stream
+    class ContentStreamParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute sec_web_socket_protocol
+      #
+      #   @return [Symbol, ModerationAPI::Models::ContentStreamParams::SecWebSocketProtocol]
+      required :sec_web_socket_protocol, enum: -> { ModerationAPI::ContentStreamParams::SecWebSocketProtocol }
+
+      # @!method initialize(sec_web_socket_protocol:, request_options: {})
+      #   @param sec_web_socket_protocol [Symbol, ModerationAPI::Models::ContentStreamParams::SecWebSocketProtocol]
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      module SecWebSocketProtocol
+        extend ModerationAPI::Internal::Type::Enum
+
+        MODERATIONAPI_V1 = :"moderationapi.v1"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/content_submit_response.rb

@@ -11,6 +11,16 @@ module ModerationAPI
       #   @return [ModerationAPI::Models::ContentSubmitResponse::Author, nil]
       required :author, -> { ModerationAPI::Models::ContentSubmitResponse::Author }, nil?: true
 
+      # @!attribute casebook
+      #   What your casebook — the record of your past moderation decisions — found for
+      #   this content, or null when it had nothing close enough to say, when the matching
+      #   cases disagreed, or when casebook lookups are not switched on for this channel.
+      #   Reports what the casebook found; whether it decided the outcome is shown in
+      #   `recommendation`, where a higher-priority rule may have settled the item first.
+      #
+      #   @return [ModerationAPI::Models::ContentSubmitResponse::Casebook, nil]
+      required :casebook, -> { ModerationAPI::Models::ContentSubmitResponse::Casebook }, nil?: true
+
       # @!attribute content
       #   Potentially modified content.
       #
@@ -56,12 +66,14 @@ module ModerationAPI
       optional :errors,
                -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ContentSubmitResponse::Error] }
 
-      # @!method initialize(author:, content:, evaluation:, insights:, meta:, policies:, recommendation:, errors: nil)
+      # @!method initialize(author:, casebook:, content:, evaluation:, insights:, meta:, policies:, recommendation:, errors: nil)
       #   Some parameter documentations has been truncated, see
       #   {ModerationAPI::Models::ContentSubmitResponse} for more details.
       #
       #   @param author [ModerationAPI::Models::ContentSubmitResponse::Author, nil] The author of the content if your account has authors enabled. Requires you to s
       #
+      #   @param casebook [ModerationAPI::Models::ContentSubmitResponse::Casebook, nil] What your casebook — the record of your past moderation decisions — found for th
+      #
       #   @param content [ModerationAPI::Models::ContentSubmitResponse::Content] Potentially modified content.
       #
       #   @param evaluation [ModerationAPI::Models::ContentSubmitResponse::Evaluation] The evaluation of the content after running the channel policies.
@@ -178,6 +190,109 @@ module ModerationAPI
         end
       end
 
+      # @see ModerationAPI::Models::ContentSubmitResponse#casebook
+      class Casebook < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute agreement
+        #   How unanimous the matching cases are, from 0 to 1: the share of them that
+        #   decided this way, ignoring how many there are. Always at least 0.8 when a ruling
+        #   is returned — below that the casebook reports a disagreement instead of picking
+        #   a side — so it tells you how clean the consensus was, and is not a threshold to
+        #   re-apply yourself.
+        #
+        #   @return [Float]
+        required :agreement, Float
+
+        # @!attribute case_count
+        #   How many of your past cases backed this ruling.
+        #
+        #   @return [Float]
+        required :case_count, Float
+
+        # @!attribute confidence
+        #   How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled
+        #   by how much evidence backs it, so a handful of close, recent cases outweighs one
+        #   distant one. Older cases count for less, halving in weight roughly every 180
+        #   days. This is the number to use in rules when you want a strength condition.
+        #
+        #   @return [Float]
+        required :confidence, Float
+
+        # @!attribute similarity
+        #   How close the nearest matching case is, from 0 to 1. 1 means the content is
+        #   identical to something you have already decided.
+        #
+        #   @return [Float]
+        required :similarity, Float
+
+        # @!attribute topic
+        #   The topic the closest matching case is filed under, or null when it has not been
+        #   grouped into one yet.
+        #
+        #   @return [ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic, nil]
+        required :topic, -> { ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic }, nil?: true
+
+        # @!attribute verdict
+        #   The ruling your past decisions point to for this content.
+        #
+        #   @return [Symbol, ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict]
+        required :verdict, enum: -> { ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict }
+
+        # @!method initialize(agreement:, case_count:, confidence:, similarity:, topic:, verdict:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModerationAPI::Models::ContentSubmitResponse::Casebook} for more details.
+        #
+        #   What your casebook — the record of your past moderation decisions — found for
+        #   this content, or null when it had nothing close enough to say, when the matching
+        #   cases disagreed, or when casebook lookups are not switched on for this channel.
+        #   Reports what the casebook found; whether it decided the outcome is shown in
+        #   `recommendation`, where a higher-priority rule may have settled the item first.
+        #
+        #   @param agreement [Float] How unanimous the matching cases are, from 0 to 1: the share of them that decide
+        #
+        #   @param case_count [Float] How many of your past cases backed this ruling.
+        #
+        #   @param confidence [Float] How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled b
+        #
+        #   @param similarity [Float] How close the nearest matching case is, from 0 to 1. 1 means the content is iden
+        #
+        #   @param topic [ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic, nil] The topic the closest matching case is filed under, or null when it has not been
+        #
+        #   @param verdict [Symbol, ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict] The ruling your past decisions point to for this content.
+
+        # @see ModerationAPI::Models::ContentSubmitResponse::Casebook#topic
+        class Topic < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute label
+          #
+          #   @return [String]
+          required :label, String
+
+          # @!method initialize(id:, label:)
+          #   The topic the closest matching case is filed under, or null when it has not been
+          #   grouped into one yet.
+          #
+          #   @param id [String]
+          #   @param label [String]
+        end
+
+        # The ruling your past decisions point to for this content.
+        #
+        # @see ModerationAPI::Models::ContentSubmitResponse::Casebook#verdict
+        module Verdict
+          extend ModerationAPI::Internal::Type::Enum
+
+          ALLOW = :allow
+          REJECT = :reject
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ModerationAPI::Models::ContentSubmitResponse#content
       class Content < ModerationAPI::Internal::Type::BaseModel
         # @!attribute id
@@ -935,6 +1050,8 @@ module ModerationAPI
 
           variant const: -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::CLIENT_OVERRIDE }
 
+          variant const: -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::CASEBOOK_MATCH }
+
           variant String
 
           # @!method self.variants
@@ -956,6 +1073,7 @@ module ModerationAPI
           RULE_DEFAULT = :rule_default
           RULE_FALLBACK = :rule_fallback
           CLIENT_OVERRIDE = :client_override
+          CASEBOOK_MATCH = :casebook_match
 
           # @!endgroup
         end

data/lib/moderation_api/models/webhook_create_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#create
+    class WebhookCreateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute event_types
+      #   Event types this webhook subscribes to. One webhook URL receives all events you
+      #   list here.
+      #
+      #   @return [Array<Symbol, ModerationAPI::Models::WebhookCreateParams::EventType>]
+      required :event_types,
+               -> {
+                 ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::WebhookCreateParams::EventType]
+               },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #   The webhook's name, used to identify it in the dashboard
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute url
+      #   The webhook's URL. We'll call this URL when an event occurs.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   The webhook's description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(event_types:, name:, url:, description: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookCreateParams} for more details.
+      #
+      #   @param event_types [Array<Symbol, ModerationAPI::Models::WebhookCreateParams::EventType>] Event types this webhook subscribes to. One webhook URL receives all events you
+      #
+      #   @param name [String] The webhook's name, used to identify it in the dashboard
+      #
+      #   @param url [String] The webhook's URL. We'll call this URL when an event occurs.
+      #
+      #   @param description [String, nil] The webhook's description
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        QUEUE_ITEM_NEW = :QUEUE_ITEM_NEW
+        QUEUE_ITEM_COMPLETED = :QUEUE_ITEM_COMPLETED
+        QUEUE_ITEM_ACTION = :QUEUE_ITEM_ACTION
+        QUEUE_ITEM_REJECTED = :QUEUE_ITEM_REJECTED
+        QUEUE_ITEM_ALLOWED = :QUEUE_ITEM_ALLOWED
+        AUTHOR_BLOCKED = :AUTHOR_BLOCKED
+        AUTHOR_UNBLOCKED = :AUTHOR_UNBLOCKED
+        AUTHOR_SUSPENDED = :AUTHOR_SUSPENDED
+        AUTHOR_UPDATED = :AUTHOR_UPDATED
+        AUTHOR_TRUST_LEVEL_CHANGED = :AUTHOR_TRUST_LEVEL_CHANGED
+        AUTHOR_ACTION = :AUTHOR_ACTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/webhook_create_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#create
+    class WebhookCreateResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the webhook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The date the webhook was created.
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute event_types
+      #   Event types this webhook subscribes to. Empty for legacy v1 webhooks, which
+      #   subscribe via their single deprecated `type` instead.
+      #
+      #   @return [Array<Symbol, ModerationAPI::Models::WebhookCreateResponse::EventType>]
+      required :event_types,
+               -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::WebhookCreateResponse::EventType] },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #   The webhook's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute payload_version
+      #   Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #   shape and is read-only via this API.
+      #
+      #   @return [Symbol, ModerationAPI::Models::WebhookCreateResponse::PayloadVersion]
+      required :payload_version,
+               enum: -> { ModerationAPI::Models::WebhookCreateResponse::PayloadVersion },
+               api_name: :payloadVersion
+
+      # @!attribute url
+      #   The URL we call when a subscribed event occurs.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   The webhook's description.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(id:, created_at:, event_types:, name:, payload_version:, url:, description: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookCreateResponse} for more details.
+      #
+      #   @param id [String] The ID of the webhook.
+      #
+      #   @param created_at [String] The date the webhook was created.
+      #
+      #   @param event_types [Array<Symbol, ModerationAPI::Models::WebhookCreateResponse::EventType>] Event types this webhook subscribes to. Empty for legacy v1 webhooks, which subs
+      #
+      #   @param name [String] The webhook's name.
+      #
+      #   @param payload_version [Symbol, ModerationAPI::Models::WebhookCreateResponse::PayloadVersion] Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #
+      #   @param url [String] The URL we call when a subscribed event occurs.
+      #
+      #   @param description [String, nil] The webhook's description.
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        QUEUE_ITEM_NEW = :QUEUE_ITEM_NEW
+        QUEUE_ITEM_COMPLETED = :QUEUE_ITEM_COMPLETED
+        QUEUE_ITEM_ACTION = :QUEUE_ITEM_ACTION
+        QUEUE_ITEM_REJECTED = :QUEUE_ITEM_REJECTED
+        QUEUE_ITEM_ALLOWED = :QUEUE_ITEM_ALLOWED
+        AUTHOR_BLOCKED = :AUTHOR_BLOCKED
+        AUTHOR_UNBLOCKED = :AUTHOR_UNBLOCKED
+        AUTHOR_SUSPENDED = :AUTHOR_SUSPENDED
+        AUTHOR_UPDATED = :AUTHOR_UPDATED
+        AUTHOR_TRUST_LEVEL_CHANGED = :AUTHOR_TRUST_LEVEL_CHANGED
+        AUTHOR_ACTION = :AUTHOR_ACTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      # shape and is read-only via this API.
+      #
+      # @see ModerationAPI::Models::WebhookCreateResponse#payload_version
+      module PayloadVersion
+        extend ModerationAPI::Internal::Type::Enum
+
+        V1 = :V1
+        V2 = :V2
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/webhook_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#delete
+    class WebhookDeleteParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   The ID of the webhook to delete.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the webhook to delete.
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moderation_api/models/webhook_delete_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#delete
+    class WebhookDeleteResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the webhook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute deleted
+      #   Whether the webhook was deleted.
+      #
+      #   @return [Boolean]
+      required :deleted, ModerationAPI::Internal::Type::Boolean
+
+      # @!method initialize(id:, deleted:)
+      #   @param id [String] The ID of the webhook.
+      #
+      #   @param deleted [Boolean] Whether the webhook was deleted.
+    end
+  end
+end

data/lib/moderation_api/models/webhook_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#list
+    class WebhookListParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moderation_api/models/webhook_list_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    class WebhookListResponseItem < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the webhook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The date the webhook was created.
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute event_types
+      #   Event types this webhook subscribes to. Empty for legacy v1 webhooks, which
+      #   subscribe via their single deprecated `type` instead.
+      #
+      #   @return [Array<Symbol, ModerationAPI::Models::WebhookListResponseItem::EventType>]
+      required :event_types,
+               -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::WebhookListResponseItem::EventType] },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #   The webhook's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute payload_version
+      #   Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #   shape and is read-only via this API.
+      #
+      #   @return [Symbol, ModerationAPI::Models::WebhookListResponseItem::PayloadVersion]
+      required :payload_version,
+               enum: -> { ModerationAPI::Models::WebhookListResponseItem::PayloadVersion },
+               api_name: :payloadVersion
+
+      # @!attribute url
+      #   The URL we call when a subscribed event occurs.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   The webhook's description.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(id:, created_at:, event_types:, name:, payload_version:, url:, description: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookListResponseItem} for more details.
+      #
+      #   @param id [String] The ID of the webhook.
+      #
+      #   @param created_at [String] The date the webhook was created.
+      #
+      #   @param event_types [Array<Symbol, ModerationAPI::Models::WebhookListResponseItem::EventType>] Event types this webhook subscribes to. Empty for legacy v1 webhooks, which subs
+      #
+      #   @param name [String] The webhook's name.
+      #
+      #   @param payload_version [Symbol, ModerationAPI::Models::WebhookListResponseItem::PayloadVersion] Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #
+      #   @param url [String] The URL we call when a subscribed event occurs.
+      #
+      #   @param description [String, nil] The webhook's description.
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        QUEUE_ITEM_NEW = :QUEUE_ITEM_NEW
+        QUEUE_ITEM_COMPLETED = :QUEUE_ITEM_COMPLETED
+        QUEUE_ITEM_ACTION = :QUEUE_ITEM_ACTION
+        QUEUE_ITEM_REJECTED = :QUEUE_ITEM_REJECTED
+        QUEUE_ITEM_ALLOWED = :QUEUE_ITEM_ALLOWED
+        AUTHOR_BLOCKED = :AUTHOR_BLOCKED
+        AUTHOR_UNBLOCKED = :AUTHOR_UNBLOCKED
+        AUTHOR_SUSPENDED = :AUTHOR_SUSPENDED
+        AUTHOR_UPDATED = :AUTHOR_UPDATED
+        AUTHOR_TRUST_LEVEL_CHANGED = :AUTHOR_TRUST_LEVEL_CHANGED
+        AUTHOR_ACTION = :AUTHOR_ACTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      # shape and is read-only via this API.
+      #
+      # @see ModerationAPI::Models::WebhookListResponseItem#payload_version
+      module PayloadVersion
+        extend ModerationAPI::Internal::Type::Enum
+
+        V1 = :V1
+        V2 = :V2
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+
+    # @type [ModerationAPI::Internal::Type::Converter]
+    WebhookListResponse =
+      ModerationAPI::Internal::Type::ArrayOf[-> { ModerationAPI::Models::WebhookListResponseItem }]
+  end
+end

data/lib/moderation_api/models/webhook_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#retrieve
+    class WebhookRetrieveParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   The ID of the webhook to get.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the webhook to get.
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end