Module: Nahook

Defined in:
lib/nahook.rb,
lib/nahook/client.rb,
lib/nahook/errors.rb,
lib/nahook/version.rb,
lib/nahook/management.rb,
lib/nahook/http_client.rb,
lib/nahook/resources/endpoints.rb,
lib/nahook/resources/deliveries.rb,
lib/nahook/resources/event_types.rb,
lib/nahook/resources/applications.rb,
lib/nahook/resources/environments.rb,
lib/nahook/resources/subscriptions.rb,
lib/nahook/resources/portal_sessions.rb

Overview

Official Ruby SDK for the Nahook webhook platform.

Nahook provides two main entry points:

  • Client for sending webhook payloads (ingestion API)

  • Management for managing resources (management API)

Examples:

Sending a webhook

client = Nahook::Client.new("nhk_us_your_api_key")
client.send("ep_abc123", payload: { order_id: "12345" })

Managing endpoints

mgmt = Nahook::Management.new("nhm_your_token")
mgmt.endpoints.list("ws_abc123")

Defined Under Namespace

Modules: Resources Classes: APIError, Client, Error, HttpClient, Management, NetworkError, PaginatedResult, TimeoutError

Constant Summary collapse

UNSET =

Sentinel distinguishing “argument not passed” from an explicit nil.

Used for tri-state PATCH fields like max_endpoints: leaving the argument as UNSET omits it from the request body (unchanged), while passing nil sends an explicit JSON null (clear).

Object.new
VERSION = 
"0.3.0"