HookSniffAPI.Api.Stream (HookSniff v0.3.0)

Copy Markdown View Source

API calls for all endpoints tagged Stream.

Summary

Functions

Real-time delivery event stream (SSE) Server-Sent Events stream of webhook deliveries

Functions

stream_deliveries_get(connection, opts \\ [])

@spec stream_deliveries_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, String.t()} | {:error, Tesla.Env.t()}

Real-time delivery event stream (SSE) Server-Sent Events stream of webhook deliveries

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :endpoint_id (String.t):
    • :status (String.t):
    • :limit (integer()):

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure