handinger 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e43a5f9df9dc47be5da0cb54df3bbd3a9caa7b0f32e35981f4375b443774e4
-  data.tar.gz: 105454fa3a99cc7b62cf7241dd8dfaf72190f01f5208f171da41265cd577f8e3
+  metadata.gz: c2da95055e66f45cde46af0ef457dd77d4583bd7946d6f3c244fb9281f93b0e4
+  data.tar.gz: 8735d12d6338850b6ca41a70cff2ab88b6b1f0b67dacc7722743ca79962c6a16
 SHA512:
-  metadata.gz: 8ac4f97f05e1380cffc03eccbbd7343e6cbe10d6d5c23a491f5e36a4e76c58febb0db9dbed58d627cfba60062feda20df24214fe87883f9ae10f968ac5fc65c4
-  data.tar.gz: 8b9fa07b57feebd1066bac295f738ab3bf66a239c68b6a988e895212774c5dda056fbb4a1dde66ff94d01c182a02cfd4a2da73c983d29a73665b75c06e675143
+  metadata.gz: 06e00886ab79b1ef3daf23fc66b732611f37065f7d8f9585ff18e48c00798430b4264f94bcdc594353bb3e5277ae5e29ca6ad549a8cc38c36e5da2c20ee2161c
+  data.tar.gz: c6da45cc9db8b1a80166d30c45fc191d15ec6deb62973ae2f563cf911fff0acca95d6df67527d5f4199e74f7c79ab826b3d3ad40ffbc62112f4b8bf459306dbe

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.8.0 (2026-05-11)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/ramensoft/handinger-ruby/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** api update ([96453f6](https://github.com/ramensoft/handinger-ruby/commit/96453f63068bbf90122a10ffdfccec3c1760395f))
+
+## 0.7.0 (2026-05-11)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/Ramensoft/handinger-ruby/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* Add Webhook API docs ([a35a412](https://github.com/Ramensoft/handinger-ruby/commit/a35a412297f5103e8856e2da5d72891a3dde3a91))
+
 ## 0.6.0 (2026-05-11)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/Ramensoft/handinger-ruby/compare/v0.5.0...v0.6.0)

data/README.md

@@ -1,6 +1,6 @@
 # Handinger Ruby API library
 
-The Handinger Ruby library provides convenient access to the Handinger REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Ramensoft/handinger-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+The Handinger Ruby library provides convenient access to the Handinger REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/ramensoft/handinger-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "handinger", "~> 0.6.0"
+gem "handinger", "~> 0.8.0"
 ```
 
 <!-- x-release-please-end -->
@@ -244,4 +244,4 @@ Ruby 3.2.0 or higher.
 
 ## Contributing
 
-See [the contributing documentation](https://github.com/Ramensoft/handinger-ruby/tree/main/CONTRIBUTING.md).
+See [the contributing documentation](https://github.com/ramensoft/handinger-ruby/tree/main/CONTRIBUTING.md).

data/lib/handinger/models/workers/update_webhook.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      class UpdateWebhook < Handinger::Internal::Type::BaseModel
+        # @!attribute url
+        #   HTTPS endpoint Handinger should POST to when a task finishes. Pass `null` to
+        #   remove the webhook and clear its token.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(url:)
+        #   Some parameter documentations has been truncated, see
+        #   {Handinger::Models::Workers::UpdateWebhook} for more details.
+        #
+        #   @param url [String, nil] HTTPS endpoint Handinger should POST to when a task finishes. Pass `null` to rem
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#retrieve
+      class Webhook < Handinger::Internal::Type::BaseModel
+        # @!attribute token
+        #   Shared secret sent in the `X-Handinger-Token` header on each delivery. `null`
+        #   when no webhook is configured.
+        #
+        #   @return [String, nil]
+        required :token, String, nil?: true
+
+        # @!attribute url
+        #   HTTPS endpoint that receives webhook deliveries when a task completes. `null`
+        #   when no webhook is configured.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(token:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {Handinger::Models::Workers::Webhook} for more details.
+        #
+        #   @param token [String, nil] Shared secret sent in the `X-Handinger-Token` header on each delivery. `null` wh
+        #
+        #   @param url [String, nil] HTTPS endpoint that receives webhook deliveries when a task completes. `null` wh
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_delete_params.rb

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

data/lib/handinger/models/workers/webhook_execution.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      class WebhookExecution < Handinger::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute duration_ms
+        #   Wall-clock time spent on the delivery attempt.
+        #
+        #   @return [Integer]
+        required :duration_ms, Integer, api_name: :durationMs
+
+        # @!attribute error_message
+        #   Failure reason when `requestStatus` is `error`.
+        #
+        #   @return [String, nil]
+        required :error_message, String, api_name: :errorMessage, nil?: true
+
+        # @!attribute request_status
+        #   `success` when the endpoint returned a 2xx response, `error` otherwise.
+        #
+        #   @return [Symbol, Handinger::Models::Workers::WebhookExecution::RequestStatus]
+        required :request_status,
+                 enum: -> { Handinger::Workers::WebhookExecution::RequestStatus },
+                 api_name: :requestStatus
+
+        # @!attribute response_status
+        #   HTTP status returned by the endpoint, when reachable.
+        #
+        #   @return [Integer, nil]
+        required :response_status, Integer, api_name: :responseStatus, nil?: true
+
+        # @!attribute task_id
+        #   Task that triggered the delivery, when available.
+        #
+        #   @return [String, nil]
+        required :task_id, String, api_name: :taskId, nil?: true
+
+        # @!attribute task_title
+        #   Title of the originating task, when available.
+        #
+        #   @return [String, nil]
+        required :task_title, String, api_name: :taskTitle, nil?: true
+
+        # @!attribute url
+        #   Endpoint Handinger attempted to deliver to.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String, api_name: :workerId
+
+        # @!method initialize(id:, created_at:, duration_ms:, error_message:, request_status:, response_status:, task_id:, task_title:, url:, worker_id:)
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param duration_ms [Integer] Wall-clock time spent on the delivery attempt.
+        #
+        #   @param error_message [String, nil] Failure reason when `requestStatus` is `error`.
+        #
+        #   @param request_status [Symbol, Handinger::Models::Workers::WebhookExecution::RequestStatus] `success` when the endpoint returned a 2xx response, `error` otherwise.
+        #
+        #   @param response_status [Integer, nil] HTTP status returned by the endpoint, when reachable.
+        #
+        #   @param task_id [String, nil] Task that triggered the delivery, when available.
+        #
+        #   @param task_title [String, nil] Title of the originating task, when available.
+        #
+        #   @param url [String] Endpoint Handinger attempted to deliver to.
+        #
+        #   @param worker_id [String]
+
+        # `success` when the endpoint returned a 2xx response, `error` otherwise.
+        #
+        # @see Handinger::Models::Workers::WebhookExecution#request_status
+        module RequestStatus
+          extend Handinger::Internal::Type::Enum
+
+          SUCCESS = :success
+          ERROR = :error
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_execution_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#list_executions
+      class WebhookExecutionList < Handinger::Internal::Type::BaseModel
+        # @!attribute logs
+        #
+        #   @return [Array<Handinger::Models::Workers::WebhookExecution>]
+        required :logs, -> { Handinger::Internal::Type::ArrayOf[Handinger::Workers::WebhookExecution] }
+
+        # @!attribute page
+        #   Current page number.
+        #
+        #   @return [Integer]
+        required :page, Integer
+
+        # @!attribute page_count
+        #   Total number of pages available.
+        #
+        #   @return [Integer]
+        required :page_count, Integer, api_name: :pageCount
+
+        # @!attribute total_count
+        #   Total number of executions recorded.
+        #
+        #   @return [Integer]
+        required :total_count, Integer, api_name: :totalCount
+
+        # @!method initialize(logs:, page:, page_count:, total_count:)
+        #   @param logs [Array<Handinger::Models::Workers::WebhookExecution>]
+        #
+        #   @param page [Integer] Current page number.
+        #
+        #   @param page_count [Integer] Total number of pages available.
+        #
+        #   @param total_count [Integer] Total number of executions recorded.
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_list_executions_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#list_executions
+      class WebhookListExecutionsParams < Handinger::Internal::Type::BaseModel
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!attribute page
+        #   Page number (1-indexed). Defaults to 1.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!method initialize(worker_id:, page: nil, request_options: {})
+        #   @param worker_id [String]
+        #
+        #   @param page [Integer] Page number (1-indexed). Defaults to 1.
+        #
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_regenerate_token_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#regenerate_token
+      class WebhookRegenerateTokenParams < Handinger::Internal::Type::BaseModel
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!method initialize(worker_id:, request_options: {})
+        #   @param worker_id [String]
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#retrieve
+      class WebhookRetrieveParams < Handinger::Internal::Type::BaseModel
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!method initialize(worker_id:, request_options: {})
+        #   @param worker_id [String]
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_update_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#update
+      class WebhookUpdateParams < Handinger::Models::Workers::UpdateWebhook
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!method initialize(worker_id:, request_options: {})
+        #   @param worker_id [String]
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/resources/workers/webhooks.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Resources
+    class Workers
+      # Configure outbound webhooks delivered when a worker's tasks complete.
+      class Webhooks
+        # Retrieve the webhook URL and shared token configured for a worker. Both fields
+        # are `null` when no webhook is configured. Only the worker creator can read the
+        # webhook configuration.
+        #
+        # @overload retrieve(worker_id, request_options: {})
+        #
+        # @param worker_id [String] Worker id returned by the create worker endpoint.
+        #
+        # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Handinger::Models::Workers::Webhook]
+        #
+        # @see Handinger::Models::Workers::WebhookRetrieveParams
+        def retrieve(worker_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/workers/%1$s/webhook", worker_id],
+            model: Handinger::Workers::Webhook,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Handinger::Models::Workers::WebhookUpdateParams} for more details.
+        #
+        # Set or replace the webhook URL for a worker. A fresh token is generated the
+        # first time a URL is set; subsequent updates keep the existing token. Pass
+        # `url: null` to clear the webhook (use the dedicated DELETE for the same effect).
+        # Only the worker creator can update the webhook.
+        #
+        # @overload update(worker_id, url:, request_options: {})
+        #
+        # @param worker_id [String] Worker id returned by the create worker endpoint.
+        #
+        # @param url [String, nil] HTTPS endpoint Handinger should POST to when a task finishes. Pass `null` to rem
+        #
+        # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Handinger::Models::Workers::Webhook]
+        #
+        # @see Handinger::Models::Workers::WebhookUpdateParams
+        def update(worker_id, params)
+          parsed, options = Handinger::Workers::WebhookUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["api/workers/%1$s/webhook", worker_id],
+            body: parsed,
+            model: Handinger::Workers::Webhook,
+            options: options
+          )
+        end
+
+        # Remove the webhook from a worker. Both `url` and `token` are cleared and no
+        # further deliveries are attempted. Only the worker creator can delete the
+        # webhook.
+        #
+        # @overload delete(worker_id, request_options: {})
+        #
+        # @param worker_id [String] Worker id returned by the create worker endpoint.
+        #
+        # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Handinger::Models::Workers::Webhook]
+        #
+        # @see Handinger::Models::Workers::WebhookDeleteParams
+        def delete(worker_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["api/workers/%1$s/webhook", worker_id],
+            model: Handinger::Workers::Webhook,
+            options: params[:request_options]
+          )
+        end
+
+        # List recent webhook delivery attempts for a worker, newest first, paginated 50
+        # per page. Only the worker creator can read execution history.
+        #
+        # @overload list_executions(worker_id, page: nil, request_options: {})
+        #
+        # @param worker_id [String] Worker id returned by the create worker endpoint.
+        #
+        # @param page [Integer] Page number (1-indexed). Defaults to 1.
+        #
+        # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Handinger::Models::Workers::WebhookExecutionList]
+        #
+        # @see Handinger::Models::Workers::WebhookListExecutionsParams
+        def list_executions(worker_id, params = {})
+          parsed, options = Handinger::Workers::WebhookListExecutionsParams.dump_request(params)
+          query = Handinger::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["api/workers/%1$s/webhook/executions", worker_id],
+            query: query,
+            model: Handinger::Workers::WebhookExecutionList,
+            options: options
+          )
+        end
+
+        # Issue a new shared token for the webhook, invalidating the previous one. The
+        # webhook URL is preserved. Only the worker creator can regenerate the token.
+        #
+        # @overload regenerate_token(worker_id, request_options: {})
+        #
+        # @param worker_id [String] Worker id returned by the create worker endpoint.
+        #
+        # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Handinger::Models::Workers::Webhook]
+        #
+        # @see Handinger::Models::Workers::WebhookRegenerateTokenParams
+        def regenerate_token(worker_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["api/workers/%1$s/webhook/regenerate-token", worker_id],
+            model: Handinger::Workers::Webhook,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Handinger::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/handinger/resources/workers.rb

@@ -8,6 +8,10 @@ module Handinger
       # @return [Handinger::Resources::Workers::Schedules]
       attr_reader :schedules
 
+      # Configure outbound webhooks delivered when a worker's tasks complete.
+      # @return [Handinger::Resources::Workers::Webhooks]
+      attr_reader :webhooks
+
       # Some parameter documentations has been truncated, see
       # {Handinger::Models::WorkerCreateParams} for more details.
       #
@@ -159,6 +163,7 @@ module Handinger
       def initialize(client:)
         @client = client
         @schedules = Handinger::Resources::Workers::Schedules.new(client: client)
+        @webhooks = Handinger::Resources::Workers::Webhooks.new(client: client)
       end
     end
   end

data/lib/handinger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Handinger
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/handinger.rb

@@ -54,6 +54,7 @@ require_relative "handinger/internal/transport/pooled_net_requester"
 require_relative "handinger/client"
 require_relative "handinger/models/create_task"
 require_relative "handinger/models/create_worker"
+require_relative "handinger/models/workers/update_webhook"
 require_relative "handinger/models/update_worker"
 require_relative "handinger/models/delete_task_response"
 require_relative "handinger/models/delete_worker_response"
@@ -73,6 +74,14 @@ require_relative "handinger/models/workers/schedule_cancel_response"
 require_relative "handinger/models/workers/schedule_create_params"
 require_relative "handinger/models/workers/schedule_list_params"
 require_relative "handinger/models/workers/schedule_list_response"
+require_relative "handinger/models/workers/webhook"
+require_relative "handinger/models/workers/webhook_delete_params"
+require_relative "handinger/models/workers/webhook_execution"
+require_relative "handinger/models/workers/webhook_execution_list"
+require_relative "handinger/models/workers/webhook_list_executions_params"
+require_relative "handinger/models/workers/webhook_regenerate_token_params"
+require_relative "handinger/models/workers/webhook_retrieve_params"
+require_relative "handinger/models/workers/webhook_update_params"
 require_relative "handinger/models/workers/worker_schedule"
 require_relative "handinger/models/worker_template"
 require_relative "handinger/models/worker_update_params"
@@ -80,3 +89,4 @@ require_relative "handinger/models"
 require_relative "handinger/resources/tasks"
 require_relative "handinger/resources/workers"
 require_relative "handinger/resources/workers/schedules"
+require_relative "handinger/resources/workers/webhooks"

data/rbi/handinger/models/workers/update_webhook.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Handinger
+  module Models
+    module Workers
+      class UpdateWebhook < Handinger::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Handinger::Workers::UpdateWebhook,
+              Handinger::Internal::AnyHash
+            )
+          end
+
+        # HTTPS endpoint Handinger should POST to when a task finishes. Pass `null` to
+        # remove the webhook and clear its token.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig { params(url: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # HTTPS endpoint Handinger should POST to when a task finishes. Pass `null` to
+          # remove the webhook and clear its token.
+          url:
+        )
+        end
+
+        sig { override.returns({ url: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/handinger/models/workers/webhook.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Handinger
+  module Models
+    module Workers
+      class Webhook < Handinger::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Handinger::Workers::Webhook, Handinger::Internal::AnyHash)
+          end
+
+        # Shared secret sent in the `X-Handinger-Token` header on each delivery. `null`
+        # when no webhook is configured.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :token
+
+        # HTTPS endpoint that receives webhook deliveries when a task completes. `null`
+        # when no webhook is configured.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig do
+          params(token: T.nilable(String), url: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Shared secret sent in the `X-Handinger-Token` header on each delivery. `null`
+          # when no webhook is configured.
+          token:,
+          # HTTPS endpoint that receives webhook deliveries when a task completes. `null`
+          # when no webhook is configured.
+          url:
+        )
+        end
+
+        sig do
+          override.returns({ token: T.nilable(String), url: T.nilable(String) })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end