Grapple
Webhook magic in Elixir
Installation
If available in Hex, the package can be installed as:
Add
grapple
to your list of dependencies inmix.exs
:def deps do [{:grapple, "~> 0.1.0"}] end ```
Ensure
grapple
is started before your application:def application do [applications: [:grapple]] end `` ## Running
iex -S mix
## Documentation
https://hexdocs.pm/grapple/0.1.0
<hr>
## Direct API Usage
The default struct, `%Grapple.Hook{}`, has the following fields: `topic`, `url`, `owner`, `life`, `ref`, `method`, `headers`, `body`, and `query`. Note that `topic` and `url` are **required**. _TODO: make this configurable.__
To subscribe to a webhook, pass a `Hook` to the `subscribe` function, which returns the topic name and the unique refernce to that particular hook:
hook = %Grapple.Hook{topic: “pokemon”, url: “http://pokeapi.co/api/v2/pokemon/149"} {topic, ref} = Grapple.Hook.subscribe(hook)
To broadcast a webhook, pass a `topic` to `broadast`. This will trigger HTTP requests for any stored hooks whose `topic` values match the given `topic`, and return the parsed responses.
Grapple.Hook.broadcast(topic)