HookSniffAPI.Api.Inbound (HookSniff v0.3.0)

API calls for all endpoints tagged Inbound.

Summary

Functions

inbound_provider_endpoint_id_post(connection, provider, endpoint_id, body, opts \\ [])

Receive inbound webhook for a specific endpoint

inbound_provider_post(connection, provider, body, opts \\ [])

Receive inbound webhook from a provider Accepts webhooks from external providers (Stripe, GitHub, etc.) and routes them to the customer's endpoints.

Functions

inbound_provider_endpoint_id_post(connection, provider, endpoint_id, body, opts \\ [])

@spec inbound_provider_endpoint_id_post(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Receive inbound webhook for a specific endpoint

Parameters

connection (HookSniffAPI.Connection): Connection to server
provider (String.t):
endpoint_id (String.t):
body (map()):
opts (keyword): Optional parameters

Returns

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

inbound_provider_post(connection, provider, body, opts \\ [])

@spec inbound_provider_post(
  Tesla.Env.client(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Receive inbound webhook from a provider Accepts webhooks from external providers (Stripe, GitHub, etc.) and routes them to the customer's endpoints.

Parameters

connection (HookSniffAPI.Connection): Connection to server
provider (String.t):
body (map()):
opts (keyword): Optional parameters

Returns

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