simple_slack v1.1.0 SimpleSlack

Functions to notify slack. For simple text notification, just use notify_text/2.

iex> token = "T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
iex> SimpleSlack.notify_text(token, "Ika is a sushi.")

Link to this section Summary

Functions

Notify slack by using incoming hook. This function sends a POST request asynchronously

Equivalent to notify(token, Map.put(opts, :text, text))

Called when an application is started

Equivalent to notify(token, payload) but blocks and returns :ok or {:error, reason}

Link to this section Functions

Link to this function notify(token, payload)
notify(binary(), map()) :: :ok

Notify slack by using incoming hook. This function sends a POST request asynchronously.

Link to this function notify_text(token, text, opts \\ %{})
notify_text(binary(), binary(), map()) :: :ok

Equivalent to notify(token, Map.put(opts, :text, text)).

Link to this function start(type, args)

Called when an application is started.

This function is called when an application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another node and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.

Link to this function sync_notify(token, payload)
sync_notify(binary(), map()) ::
  :ok | {:error, HTTPoison.Response.t()} | {:error, any()}

Equivalent to notify(token, payload) but blocks and returns :ok or {:error, reason}.