0.0
No commit activity in last 3 years
No release in over 3 years
A Rack endpoint for handling Shopify webhooks, and fires an ActiveSupport notification for each succesful request.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0.6.2
~> 3.1.0

Runtime

>= 1.3.0
>= 0
 Project Readme

Shopify Webhook

A Rack endpoint for handling Shopify webhooks, and fires an ActiveSupport notification for each succesful request.

Build Status Code Climate

Installation

Add this line to your application's Gemfile:

gem 'shopify_webhook', '0.1.0'

Usage

Mount an instance of ShopifyWebhook::Endpoint to your preferred route. In a Rails app, that'd look something like this:

post '/shopify/webhook', to: ShopifyWebhook::Endpoint.new(SHARED_SECRET)

Then, handle the notifications using something like the following (which would probably go in an initialiser for a Rails app):

ActiveSupport::Notifications.subscribe(
  'notification.shopify.webhook'
) do |*args|
  event = ActiveSupport::Notifications::Event.new *args
  # use event.payload[:json] however you like.
end

Contributing

  1. Fork it ( https://github.com/inspire9/shopify_webhook/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Licence

Copyright (c) 2014, Shopify Webhook is developed and maintained by Inspire9, and is released under the open MIT Licence.