HookSniff.Webhooks (hooksniff v1.0.0)

Webhook send, list, batch, replay.

Summary

Functions

get(client, id)

Get a webhook delivery by ID

list(client, opts \\ [])

List webhook deliveries (paginated). Accepts :limit and :offset opts.

list_all(client, opts \\ [])

List all webhook deliveries (auto-paginate). Accepts :limit and :max_pages opts.

replay(client, id)

Replay a webhook delivery

send_batch(client, params)

Send a batch of webhooks

send_webhook(client, params)

Send a webhook

Functions

get(client, id)

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

Get a webhook delivery by ID

list(client, opts \\ [])

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

List webhook deliveries (paginated). Accepts :limit and :offset opts.

list_all(client, opts \\ [])

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

List all webhook deliveries (auto-paginate). Accepts :limit and :max_pages opts.

replay(client, id)

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

Replay a webhook delivery

send_batch(client, params)

@spec send_batch(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}

Send a batch of webhooks

send_webhook(client, params)

@spec send_webhook(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}

Send a webhook