API Reference hooksniff v1.0.0

HookSniff SDK — A clean wrapper for the HookSniff webhook delivery API.

Alert rules and notifications.

Delivery analytics — deliveries, success rate, latency.

API key management — list, create, delete.

Authentication — register, login, 2FA, email verification, password reset.

Billing and subscription management.

HTTP client for making requests to the HookSniff API. Uses HTTPoison with retry logic and error handling.

Manage webhook endpoints — create, list, update, delete, rotate secrets.

API health check.

Pagination utilities for HookSniff SDK. Iterates through offset-based paginated endpoints.

Search webhook deliveries.

Team management — members, invite, remove.

Webhook signature verification for incoming HookSniff webhooks.

Webhook send, list, batch, replay.

API calls for all endpoints tagged APIKeys.

API calls for all endpoints tagged Admin.

API calls for all endpoints tagged Alerts.

API calls for all endpoints tagged Analytics.

API calls for all endpoints tagged AuditLog.

API calls for all endpoints tagged Auth.

API calls for all endpoints tagged Billing.

API calls for all endpoints tagged Contact.

API calls for all endpoints tagged CustomDomains.

API calls for all endpoints tagged CustomerPortal.

API calls for all endpoints tagged DeliveryDetails.

API calls for all endpoints tagged Devices.

API calls for all endpoints tagged Embed.

API calls for all endpoints tagged Endpoints.

API calls for all endpoints tagged Events.

API calls for all endpoints tagged Health.

API calls for all endpoints tagged Inbound.

API calls for all endpoints tagged Notifications.

API calls for all endpoints tagged OAuth.

API calls for all endpoints tagged OutboundIPs.

API calls for all endpoints tagged Playground.

API calls for all endpoints tagged RateLimits.

API calls for all endpoints tagged Routing.

API calls for all endpoints tagged SSO.

API calls for all endpoints tagged Schemas.

API calls for all endpoints tagged Search.

API calls for all endpoints tagged Simulator.

API calls for all endpoints tagged Stats.

API calls for all endpoints tagged Stream.

API calls for all endpoints tagged Teams.

API calls for all endpoints tagged Templates.

API calls for all endpoints tagged Transforms.

API calls for all endpoints tagged Webhooks.

Handle Tesla connections for HookSniffAPI.

Helper functions for deserializing responses into models

Monthly revenue data point

Revenue history for admin analytics

System-level status for admin dashboard

Paginated list of users for admin management

Paginated list of alert notifications

Alert notification entry

Paginated list of alert rules

Single data point in a delivery trend

Delivery trend data over a time period

A single audit log record

Paginated list of audit log entries

Response for batch webhook delivery creation

URL for the customer billing portal

Request to cancel current subscription

Result of subscription cancellation

Request to create a new alert rule

Register a new custom domain

Create a new routing rule

Create a new SSO configuration

A custom domain configured for the account

List of custom domains

Paginated list of delivery attempts

Full delivery detail including all retry attempts and endpoint info

Paginated list of registered devices

A DNS record required for domain verification

Configuration for embedded webhook dashboard

Visual customization for the embed

TOTP secret and QR code URL returned after enabling 2FA

Endpoint health metrics and status

Paginated list of endpoints

A registered event type in the system

Paginated list of event types

GDPR data export containing all user data

Raw webhook payload received from an external provider (Stripe, GitHub, etc.)

Result of processing an inbound webhook

Invite a new member to a team

Paginated list of invoices

Latency percentile breakdown for deliveries

Optional request body for explicit refresh token invalidation

OAuth authorization callback parameters

An available OAuth identity provider

List of available OAuth providers

List of static outbound IP addresses for firewall whitelisting

Test a webhook payload against an endpoint in sandbox

Result of a playground test delivery

Customer-facing portal branding and configuration

Temporary session token for the customer portal

Rate limiting configuration for an endpoint

Current rate limit usage for an endpoint

New signing secret after rotation

List of routing rules

Paginated list of registered schemas

A registered JSON Schema for event validation

Search request for webhook deliveries

Additional filters (status, endpoint_id, etc.)

Search results for webhook deliveries

Send a simulated webhook event

Result of a simulated webhook delivery

Single Sign-On configuration (SAML or OIDC)

List of SSO configurations for the account

Paginated list of teams

List of members in a team

Paginated list of webhook payload templates

Paginated list of transform rules

Request to update an existing alert rule (all fields optional)

Update an existing routing rule (all fields optional)

Update an SSO configuration (all fields optional)

Request to change subscription plan

Fields to update on a team (all optional)

Update an existing transform rule (all fields optional)

Account usage statistics summary

Result of validating an event payload against a schema

Result of domain verification attempt

Query parameters for filtering webhook deliveries

Helper functions for building Tesla requests

Tesla middleware for automatic retry on 429 (rate limit) and 5xx errors.