WebhooksEmitter.Config (webhooks_emitter v0.2.0) View Source

t() :: %WebhooksEmitter.Config{
  additional_headers: headers(),
  backoff_limit: non_neg_integer(),
  backoff_start: non_neg_integer(),
  header_identifier: String.t(),
  http_client: module(),
  insecure: boolean(),
  max_retries: non_neg_integer(),
  request_timeout: non_neg_integer(),
  secret: nil | String.t(),
  url: nil | String.t()
}

Link to this section Functions

additional_header(config, additional_header)

Specs

additional_header(t(), header()) :: t()

Set additional HTTP header to be sent along with the http request. Can be called multiple times.

## Examples
  iex> "https://host.tld/hooks"
  ...> |> WebhooksEmitter.Config.new()
  ...> |> WebhooksEmitter.Config.additional_header({"authorization", "bearer 4242"})
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", additional_headers: [{"authorization", "bearer 4242"}]}

  iex> "https://host.tld/hooks"
  ...> |> WebhooksEmitter.Config.new()
  ...> |> WebhooksEmitter.Config.additional_header({"authorization", "bearer 4242"})
  ...> |> WebhooksEmitter.Config.additional_header({"Access-Control-Allow-Origin", "*"})
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", additional_headers: [{"Access-Control-Allow-Origin", "*"}, {"authorization", "bearer 4242"}]}

allow_insecure(config)

Allow SSL insecure requests.

Examples

  iex> WebhooksEmitter.Config.new("https://host.tld/hooks")
  ...> |> WebhooksEmitter.Config.allow_insecure()
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", insecure: true}

disallow_insecure(config)

Disallow SSL insecure requests (the default).

Examples

  iex> WebhooksEmitter.Config.new("https://host.tld/hooks")
  ...> |> WebhooksEmitter.Config.disallow_insecure()
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", insecure: false}

header_identifier(config, header_identifier)

Specs

header_identifier(t(), String.t()) :: t()

Allows to change the private header identifier. By default is Webhooks, so all private headers set by this library will have X-Webhooks prefix.

## Examples
  iex> "https://host.tld/hooks"
  ...> |> WebhooksEmitter.Config.new()
  ...> |> WebhooksEmitter.Config.header_identifier("Yourapp")
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", header_identifier: "Yourapp"}

max_retries(config, max_retries)

Specs

max_retries(t(), pos_integer()) :: t()

Set the number of max retries for each delivery. Defaults to 3.

## Examples
  iex> "https://host.tld/hooks"
  ...> |> WebhooksEmitter.Config.new()
  ...> |> WebhooksEmitter.Config.max_retries(43)
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", max_retries: 43}

new(url)

Specs

new(String.t()) :: t()

Returns a new emitter config with the destination url set.

Examples

  iex> WebhooksEmitter.Config.new("https://host.tld/hooks")
  %WebhooksEmitter.Config{url: "https://host.tld/hooks"}

request_timeout(config, request_timeout)

Specs

request_timeout(t(), pos_integer()) :: t()

Set the HTTP request timeout, in milliseconds. By default is 5 seconds (5000 msec).

## Examples
  iex> "https://host.tld/hooks"
  ...> |> WebhooksEmitter.Config.new()
  ...> |> WebhooksEmitter.Config.request_timeout(2000)
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", request_timeout: 2000}

secret(config, secret)

Specs

secret(t(), String.t()) :: t()

Add a secret, which is used to compute the hmac hex digest of the body.

## Examples

  iex> "https://host.tld/hooks"
  ...> |> WebhooksEmitter.Config.new()
  ...> |> WebhooksEmitter.Config.secret("supersecret")
  %WebhooksEmitter.Config{url: "https://host.tld/hooks", secret: "supersecret"}