https://github.com/cpursley/webhoox

Inbound webhooks the easy way
https://github.com/cpursley/webhoox

adapter api callbacks connector elixir hasura http low-code mailersend mailgun mandrill parsio s3 webhook webhooks

Last synced: 5 days ago
JSON representation

Inbound webhooks the easy way

• Host: GitHub
• URL: https://github.com/cpursley/webhoox
• Owner: cpursley
• License: mit
• Created: 2022-04-14T18:51:37.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-29T23:37:32.000Z (11 months ago)
• Last Synced: 2024-09-16T09:46:19.802Z (2 months ago)
• Topics: adapter, api, callbacks, connector, elixir, hasura, http, low-code, mailersend, mailgun, mandrill, parsio, s3, webhook, webhooks
• Language: Elixir
• Homepage:
• Size: 229 KB
• Stars: 12
• Watchers: 4
• Forks: 1
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Webhoox

Webhoox makes it easy to deal with inbound webhooks by using an adapter-based approach, saving you time.

This library started off as a fork of Maarten's awesome [receivex](https://github.com/maartenvanvliet/receivex) email-focused library.

Webhoox aims to support the [Standard Webhooks](https://www.standardwebhooks.com/) spec and includes an [authentication module](./lib/webhoox/authentication/standard_webhook.ex) and [adapter](./lib/webhoox/adapters/standard_webhook.ex)

## Adapters

- [Standard Webhook](./lib/webhoox/adapters/standard_webhook.ex)

- [MailerSend](./lib/webhoox/adapters/mailersend.ex)

- [Mailgun](./lib/webhoox/adapters/mailgun.ex)

- [Mandrill](./lib/webhoox/adapters/mandrill.ex)

- [Hasura](./lib/webhoox/adapters/hasura.ex)

- [s3](./lib/webhoox/adapters/s3.ex)

- [Parsio](./lib/webhoox/adapters/parsio.ex)

You can implement your own adapter by following the existing adapters as an example. Pull requests for new adapters welcome!

## Installation

[Available in Hex](https://hex.pm/packages/webhoox), the package can be installed

by adding `webhoox` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:webhoox, "~> 0.3.0"}

  ]

end

```

## Configuration

Example configuration for Standard Webhook with the Plug router:

```elixir

# Your router.ex file

forward("_incoming", to: Webhoox, init_opts: [

  adapter: Webhoox.Adapter.StandardWebhook,

  adapter_opts: [secret: "MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"],

  handler: Example.Processor]

)

```

Example Processor:

```elixir

  defmodule Example.Processor do

    @behaviour Webhoox.Handler

    def process(webhook = %Webhoox.Webhook.StandardWebhook{}) do

      # You probably want to handle processing of the event asynchronously

      # and go ahead and return a 200 as not to block the sending server

      

      {:ok, "200 OK"}

    end

  end

```

Documentation can be found at [https://hex.pm/packages/webhoox](https://hex.pm/packages/webhoox).