HookSniffAPI.Api.Webhooks (hooksniff v1.0.0)

@spec webhooks_batch_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.BatchWebhookRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.BatchResponse.t()} | {:error, Tesla.Env.t()}

Send multiple webhooks in batch

Parameters

connection (HookSniffAPI.Connection): Connection to server
batch_webhook_request (BatchWebhookRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.BatchResponse.t} on success
{:error, Tesla.Env.t} on failure

webhooks_batch_replay_post(connection, batch_replay_request, opts \\ [])

@spec webhooks_batch_replay_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.BatchReplayRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Replay multiple deliveries by ID

Parameters

connection (HookSniffAPI.Connection): Connection to server
batch_replay_request (BatchReplayRequest):
opts (keyword): Optional parameters

Returns

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

webhooks_export_get(connection, opts \\ [])

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

Export deliveries as CSV

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :range (String.t):

Returns

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

webhooks_get(connection, opts \\ [])

@spec webhooks_get(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.DeliveryListResponse.t()} | {:error, Tesla.Env.t()}

List webhook deliveries

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :page (integer()):
- :per_page (integer()):
- :status (String.t):
- :endpoint_id (String.t):

Returns

{:ok, HookSniffAPI.Model.DeliveryListResponse.t} on success
{:error, Tesla.Env.t} on failure

webhooks_id_attempts_get(connection, id, opts \\ [])

@spec webhooks_id_attempts_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [HookSniffAPI.Model.DeliveryAttempt.t()]} | {:error, Tesla.Env.t()}

Get delivery attempts

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, [%DeliveryAttempt{}, ...]} on success
{:error, Tesla.Env.t} on failure

webhooks_id_get(connection, id, opts \\ [])

@spec webhooks_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, HookSniffAPI.Model.Delivery.t()} | {:error, Tesla.Env.t()}

Get delivery by ID

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.Delivery.t} on success
{:error, Tesla.Env.t} on failure

webhooks_id_replay_post(connection, id, opts \\ [])

@spec webhooks_id_replay_post(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, HookSniffAPI.Model.Delivery.t()} | {:error, Tesla.Env.t()}

Replay a single delivery

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.Delivery.t} on success
{:error, Tesla.Env.t} on failure

webhooks_post(connection, create_webhook_request, opts \\ [])

@spec webhooks_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.CreateWebhookRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.Delivery.t()} | {:error, Tesla.Env.t()}

Send a webhook

Parameters

connection (HookSniffAPI.Connection): Connection to server
create_webhook_request (CreateWebhookRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.Delivery.t} on success
{:error, Tesla.Env.t} on failure