HookSniff.Webhooks (HookSniff v0.2.0)

Copy Markdown View Source

Webhooks resource — send, list, replay, batch, and inspect webhooks.

Summary

Functions

Get delivery attempts.

Send multiple webhooks in a batch.

Export deliveries.

Get a delivery by ID.

List deliveries with optional filters.

Replay a delivery.

Search deliveries with filters.

Send a webhook.

Functions

attempts(client, delivery_id)

@spec attempts(HookSniff.t(), String.t()) ::
  {:ok, [map()]} | {:error, HookSniff.Error.t()}

Get delivery attempts.

batch(client, webhooks)

@spec batch(HookSniff.t(), [map()]) :: {:ok, map()} | {:error, HookSniff.Error.t()}

Send multiple webhooks in a batch.

export(client, opts \\ [])

@spec export(
  HookSniff.t(),
  keyword()
) :: {:ok, [map()] | String.t()} | {:error, HookSniff.Error.t()}

Export deliveries.

get(client, delivery_id)

@spec get(HookSniff.t(), String.t()) :: {:ok, map()} | {:error, HookSniff.Error.t()}

Get a delivery by ID.

list(client, opts \\ [])

@spec list(
  HookSniff.t(),
  keyword()
) :: {:ok, map()} | {:error, HookSniff.Error.t()}

List deliveries with optional filters.

replay(client, delivery_id)

@spec replay(HookSniff.t(), String.t()) ::
  {:ok, map()} | {:error, HookSniff.Error.t()}

Replay a delivery.

search(client, opts \\ [])

Search deliveries with filters.

Options

  • :q - Search query
  • :event - Event type filter
  • :status - Status filter
  • :endpoint_id - Endpoint ID filter
  • :page - Page number (default: 1)
  • :per_page - Results per page (default: 20)

send(client, params)

@spec send(HookSniff.t(), map()) :: {:ok, map()} | {:error, HookSniff.Error.t()}

Send a webhook.