contentful-webhook-listener

Contentful Webhook Listener

A Simple HTTP Webserver with pluggable behavior for listening to API Webhooks

Contentful

Contentful is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.

What does contentful-webhook-listener do?

The aim of contentful-webhook-listener is to have developers setting up their Contentful Webhooks for triggering background jobs.

Installation

Add this line to your application's Gemfile:

gem 'contentful-webhook-listener'

And then execute:

$ bundle

Or install it yourself as:

$ gem install contentful-webhook-listener

Usage

• Require gem:

require 'contentful/webhook/listener'

• Create your own Controllers:

class MyController < Contentful::Webhook::Listener::Controllers::Base
  def perform(request, response)
    "do your process..." # This will run on a brackground Thread
  end
end

• Configure and start your Webhook Listener

require 'logger'

Contentful::Webhook::Listener::Server.start do |config|
  config[:port] = 5678         # Optional
  config[:address] = "0.0.0.0" # Optional
  config[:logger] = Logger.new(STDOUT) # Optional, will use a NullLogger by default
  config[:endpoints] = [
    {
      endpoint: "/receive",     # Where your server will listen
      controller: MyController, # The controller that will process the endpoint
      timeout: 15               # If using Wait, will wait `X` seconds before executing
    }
  ]
end

You can add multiple endpoints, each with it's own Controller.

Webhook Aware Controllers

You can create controllers that can respond on specific Webhook events.

class MyController < Contentful::Webhook::Listener::Controllers::WebhookAware
  def publish
    # Do stuff on publish
    if webhook.entry?
      logger.info "published Entry ID: #{webhook.id} for Space: #{webhook.space_id}"
    end
  end

  def unpublish
    # Do stuff on unpublish
  end

  def archive
    # Do stuff on archive
  end

  def unarchive
    # Do stuff on unarchive
  end

  def create
    # Do stuff on create
  end

  def save
    # Do stuff on save
  end

  def delete
    # Do stuff on delete
  end
end

The controller has a webhook object bound when invoked, that has a few helpers:

• webhook.entry? will return if the webhook was fired for an Entry

• webhook.asset? will return if the webhook was fired for an Asset

• webhook.content_type? will return if the webhook was fired for a Content Type

• webhook.id will return the Resource (Entry/Asset/Content Type) ID

• webhook.space_id will return the Space ID

• webhook.sys will include the metadata for the resource

• webhook.fields will include the resource fields (not included on Unpublish)

Contributing

• Fork it ( https://github.com/[my-github-username]/contentful-webhook-listener/fork )
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create a new Pull Request