/feedback-api-backfill

Python script that backfills event data to webhook endpoints.
  1. Python 100.0%
Python

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit e426187 Jul 20, 2016 @andypiper andypiper committed on GitHub Adding image for samples gallery
Permalink
Failed to load latest commit information.
.gitignore Adding initial source. Apr 25, 2016
LICENSE Adding initial source. Apr 25, 2016
README.md Update to readme Apr 25, 2016
backfill.py fix backfill.py May 7, 2016
config_sample.py Setting some default config settings. Apr 25, 2016
requirements.txt Adding pip requirements. Apr 25, 2016
screenshot.png Adding image for samples gallery Jul 20, 2016
webhookapp.py Adding initial source. Apr 25, 2016

README.md

Feedback API Backfill

This python script will backfill Feedback API events. Event data is requested from GET feedback/events.json and then individual events are posted to existing webhook endpoint URLs.

The Feedback API is a whitelisted API. Contact your Twitter account manager for details.

Before you start

  • Run the script against a development webhook endpoint or use the provided webapp (optional instructions below).

  • Validate that the incoming data meets the requirements of your production environment.

  • Ensure your webhook endopoint can handle duplicate events. If for some reason the script fails, you may need to re-run the script.

  • If your webhook endpoint requires authentication you may need to modify the webhook request.

Running the script

  1. Install python dependencies.

    pip install -r requirements.txt

  2. Using config_sample.py as a template, create a config.py and fill in Twitter API keys, webhook URLs and other configraution settings.

  3. (optional) Start webserver to simulate webhook endpoints and test incomcoming event data. Setup config.py to POST data to http://127.0.0.1:5000/us/webhook. The webapp will print incoming event data to the terminal window.

    python webhookapp.py

  4. Run backfill.py to initiate backfilling to webhooks.

    python backfill.py