dodopayments 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777c3fbb6da9aaa355779f987cada0a8ebd8ef1c733b5a9c847bd4a58472a74f
-  data.tar.gz: e0ab15d802bbbb3db3313d15b65ad542c16b970824fff441eff5f86859d7ec24
+  metadata.gz: 288683b7ef76f820f060d6adff43714ad2fb7be3a72f47e3244d07c81e744fe8
+  data.tar.gz: 3f7d919faa8bf245058c30aa1fee3c7ab7a1a845036528e34bd3e8e81aa6f290
 SHA512:
-  metadata.gz: b0fc3d2dd44ad2d51eb148ac750941022fb91024a5630cfcb105d9404bc7953cf2914df5b87985dfeb2121e2c7c2be2f86cb2c2df1e447473dcdb79590f46eb3
-  data.tar.gz: 2d13501625d39db2d45aac9215c4a6d09a1b9bbc937a4f6be87ab2a39845bbb01f07e87d5c62b32f8523666fc357a0f53bcad4dfcdc10b60cc7dcc6e7c1d7453
+  metadata.gz: e1d7c7dc76e74e7da61a5762ec7132be03c49c1abd34b904d6c07ccfb1e9a24f0e54f45884cef06f14dbf09b695ffe6f6e8aea0719b00a2b2e532cdce79e5240
+  data.tar.gz: b0128ca6313bcabc75be7378752e04e9f4865538a0638782dd5e311467c46193aaa92798004ee9dd43970f804dffc2b7cca71df5138b16edd280ef0afbefac53

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 2.2.0 (2026-03-21)
+
+Full Changelog: [v2.1.2...v2.2.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.1.2...v2.2.0)
+
+### Features
+
+* **client:** add webhook support ([8f3488c](https://github.com/dodopayments/dodopayments-ruby/commit/8f3488c1db4e3c8b58c9d9bb208448db009c4ad3))
+
+
+### Chores
+
+* **ci:** skip uploading artifacts on stainless-internal branches ([15197f0](https://github.com/dodopayments/dodopayments-ruby/commit/15197f0450856e33a2e6fa990ea4e0d0bc294022))
+* **internal:** tweak CI branches ([dc3f7dc](https://github.com/dodopayments/dodopayments-ruby/commit/dc3f7dc0938f71b047786e11f56c4b51a1e0a776))
+* **tests:** bump steady to v0.19.4 ([4247a60](https://github.com/dodopayments/dodopayments-ruby/commit/4247a60b34ccc131f2b906b03eb0f23841a18240))
+* **tests:** bump steady to v0.19.5 ([7f4e044](https://github.com/dodopayments/dodopayments-ruby/commit/7f4e04431b6f274cccd98ef0d9bd322a1c73868a))
+
+
+### Refactors
+
+* **tests:** switch from prism to steady ([62bcdf6](https://github.com/dodopayments/dodopayments-ruby/commit/62bcdf666e0b382ba8dc83bb530cff79c31931bc))
+
 ## 2.1.2 (2026-03-06)
 
 Full Changelog: [v2.1.1...v2.1.2](https://github.com/dodopayments/dodopayments-ruby/compare/v2.1.1...v2.1.2)

data/README.md

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

data/lib/dodopayments/client.rb

@@ -24,6 +24,9 @@ module Dodopayments
     # @return [String]
     attr_reader :bearer_token
 
+    # @return [String, nil]
+    attr_reader :webhook_key
+
     # @return [Dodopayments::Resources::CheckoutSessions]
     attr_reader :checkout_sessions
 
@@ -103,6 +106,8 @@ module Dodopayments
     #
     # @param bearer_token [String, nil] Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
     #
+    # @param webhook_key [String, nil] Defaults to `ENV["DODO_PAYMENTS_WEBHOOK_KEY"]`
+    #
     # @param environment [:live_mode, :test_mode, nil] Specifies the environment to use for the API.
     #
     # Each environment maps to a different base URL:
@@ -122,6 +127,7 @@ module Dodopayments
     # @param max_retry_delay [Float]
     def initialize(
       bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
+      webhook_key: ENV["DODO_PAYMENTS_WEBHOOK_KEY"],
       environment: nil,
       base_url: ENV["DODO_PAYMENTS_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
@@ -139,6 +145,7 @@ module Dodopayments
       end
 
       @bearer_token = bearer_token.to_s
+      @webhook_key = webhook_key&.to_s
 
       super(
         base_url: base_url,

data/lib/dodopayments/resources/webhooks.rb

@@ -175,8 +175,18 @@ module Dodopayments
 
       # @param payload [String] The raw webhook payload as a string
       #
+      # @param headers [Hash{String=>String}] The raw HTTP headers that came with the payload
+      #
+      # @param key [String, nil] The webhook signing key
+      #
       # @return [Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
-      def unwrap(payload)
+      def unwrap(payload, headers:, key: @client.webhook_key)
+        if key.nil?
+          raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_key or passed in as an argument")
+        end
+
+        ::StandardWebhooks::Webhook.new(key).verify(payload, headers)
+
         parsed = JSON.parse(payload, symbolize_names: true)
         Dodopayments::Internal::Type::Converter.coerce(Dodopayments::Models::UnwrapWebhookEvent, parsed)
       end

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "2.1.2"
+  VERSION = "2.2.0"
 end

data/lib/dodopayments.rb

@@ -30,6 +30,7 @@ end
 
 # Gems.
 require "connection_pool"
+require "standardwebhooks"
 
 # Package files.
 require_relative "dodopayments/version"

data/rbi/dodopayments/client.rbi

@@ -23,6 +23,9 @@ module Dodopayments
     sig { returns(String) }
     attr_reader :bearer_token
 
+    sig { returns(T.nilable(String)) }
+    attr_reader :webhook_key
+
     sig { returns(Dodopayments::Resources::CheckoutSessions) }
     attr_reader :checkout_sessions
 
@@ -98,6 +101,7 @@ module Dodopayments
     sig do
       params(
         bearer_token: T.nilable(String),
+        webhook_key: T.nilable(String),
         environment: T.nilable(T.any(Symbol, String)),
         base_url: T.nilable(String),
         max_retries: Integer,
@@ -109,6 +113,8 @@ module Dodopayments
     def self.new(
       # Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
       bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
+      # Defaults to `ENV["DODO_PAYMENTS_WEBHOOK_KEY"]`
+      webhook_key: ENV["DODO_PAYMENTS_WEBHOOK_KEY"],
       # Specifies the environment to use for the API.
       #
       # Each environment maps to a different base URL:

data/rbi/dodopayments/resources/webhooks.rbi

@@ -171,7 +171,11 @@ module Dodopayments
       end
 
       sig do
-        params(payload: String).returns(
+        params(
+          payload: String,
+          headers: T::Hash[String, String],
+          key: T.nilable(String)
+        ).returns(
           T.any(
             Dodopayments::CreditAddedWebhookEvent,
             Dodopayments::CreditBalanceLowWebhookEvent,
@@ -208,7 +212,11 @@ module Dodopayments
       end
       def unwrap(
         # The raw webhook payload as a string
-        payload
+        payload,
+        # The raw HTTP headers that came with the payload
+        headers:,
+        # The webhook signing key
+        key: @client.webhook_key
       )
       end
 

data/sig/dodopayments/client.rbs

@@ -15,6 +15,8 @@ module Dodopayments
 
     attr_reader bearer_token: String
 
+    attr_reader webhook_key: String?
+
     attr_reader checkout_sessions: Dodopayments::Resources::CheckoutSessions
 
     attr_reader payments: Dodopayments::Resources::Payments
@@ -63,6 +65,7 @@ module Dodopayments
 
     def initialize: (
       ?bearer_token: String?,
+      ?webhook_key: String?,
       ?environment: :live_mode | :test_mode | nil,
       ?base_url: String?,
       ?max_retries: Integer,

data/sig/dodopayments/resources/webhooks.rbs

@@ -81,7 +81,9 @@ module Dodopayments
       | Dodopayments::SubscriptionUpdatedWebhookEvent)
 
       def unwrap: (
-        String payload
+        String payload,
+        headers: ::Hash[String, String],
+        ?key: String?
       ) -> (Dodopayments::CreditAddedWebhookEvent
       | Dodopayments::CreditBalanceLowWebhookEvent
       | Dodopayments::CreditDeductedWebhookEvent

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dodopayments
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Dodo Payments
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-06 00:00:00.000000000 Z
+date: 2026-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardwebhooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: support@dodopayments.com
 executables: []