ricloud-receiver sample implementation

Updated

ricloud-receiver is an example webhook receiver implementation. It is written in Python using the Django web framework, which gives us the benefits of:

  • Years of opensource security enhancements.
  • Easy to use and extensible database model layer.
  • Reasonable performance and straightforward deployment.

Getting started

In developement

The easiest way to run the receiver is on the command line using the GitHub source code. Django has a number of useful commands for getting setup quicky. For more in-depth details visit the Django docs.

Clone the repo with:

git clone git@github.com:reincubate/ricloud-receiver.git

Setup basic development configuration by renaming the file local.env.example to just local.env. The contents of this file will override the production default settings.

Run database migrations with:

./manage.py migrate

Create a superuser for the built-in admin with:

./manage.py createsuperuser

Now, you can run the development server with:

./manage.py runserver

Check that things are running by opening http://localhost:8000 in a browser. You should see a friendly message.

At this point we have a running receiver, but it's only reachable locally. The simplest way to expose it to the API's event publisher is through a utility like ngrok.

Go to the ngrok site and follow their installation instructions for your operating system.

Run the program using:

ngrok http -bind-tls=true 8000

This will setup traffic forwarding from an ngrok url to your local receiver server. You will see in the details of the ngrok url next to the 'Forwarding' entry in the commands output.

To build the full webhook receiver url, add /webhooks to the end of this url. For example, https://d2c613b6.ngrok.io becomes https://d2c613b6.ngrok.io/webhooks.

Now, you can use this webhook receiver url to setup a webhook config by following the configuration instructions.

How can we help?

Our support team are here to help!

Our office hours are Monday to Friday, 9am to 5pm GMT.

We aim to reply to all messages within one working day.

Get in touch › Our awesome support team

© 2008 - 2019 Reincubate Ltd. All rights reserved. Registered in England and Wales #5189175, VAT GB151788978. Reincubate® is a registered trademark. Privacy & terms. We recommend 2FA. Built with in London.