HookSniffAPI.Api.Playground (HookSniff v0.3.0)

Copy Markdown View Source

API calls for all endpoints tagged Playground.

Summary

Functions

playground_get(connection, opts \\ [])

Get playground info (endpoints, sample payloads)

playground_test_post(connection, test_webhook_request, opts \\ [])

Test a webhook delivery

Functions

playground_get(connection, opts \\ [])

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

Get playground info (endpoints, sample payloads)

Parameters

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

Returns

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

playground_test_post(connection, test_webhook_request, opts \\ [])

@spec playground_test_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.TestWebhookRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.TestWebhookResponse.t()} | {:error, Tesla.Env.t()}

Test a webhook delivery

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • test_webhook_request (TestWebhookRequest):
  • opts (keyword): Optional parameters

Returns

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