A webhook middleware for the ifttt.com service
PHP
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 20 commits ahead, 13 commits behind captn3m0:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
plugins
requests
wp-admin
.gitignore
README.md
index.php
log.php
plugin.php
settings.php
xmlrpc.php

README.md

ifttt-webhook

A webhook middleware for the ifttt.com service

#How To Use

  1. Change your ifttt.com wordpress server to http://ifttt.captnemo.in.
  2. You can use any username/password combination you want. ifttt will accept the authentication irrespective of what details you enter here. These details will be passed along by the webhook as well, so that you may use these as your authentication medium, perhaps.
  3. Create a recipe in ifttt which would post to your "wordpress channel". In the "Tags" field, use the webhook url that you want to use.

Connecting to ifttt-webhook

Any username/password combination will be accepted, and passed through to the webhook url. A blank password is considered valid, but ifttt invalidates a blank username.

Screenshot of a channel

Make sure that the url you specify accepts POST requests. The url is only picked up from the tags field, and all other fields are passed through to the webhook url.

Plugin support

This fork supports plugins that allow protocol specific modification of the sent webhook payload in order to match whatever format the endpoint wants.

To do this specify a plugin:xxxx category, where xxxx is the name of the class (extending "Plugin") and also the name of the .php file in the plugins directory. See the plugins/testplugin.php file for example.

#How It Works ifttt uses wordpress-xmlrpc to communicate with the wordpress blog. We present a fake-xmlrpc interface on the webadress, which causes ifttt to be fooled into thinking of this as a genuine wordpress blog. The only action that ifttt allows for wordpress are posting, which are instead used for powering webhooks. All the other fields (title, description, categories) along with the username/password credentials are passed along by the webhook. Do not use the "Create a photo post" action for wordpress, as ifttt manually adds a <img> tag in the description pointing to what url you pass. Its better to pass the url in clear instead (using body/category/title fields).

#Why There has been a lot of call for a ifttt-webhook. I had asked about it pretty early on, but ifttt has yet to create such a channel. It was fun to build and will allow me to hookup ifttt with things like partychat, github and many other awesome services for which ifttt is yet to build a channel. You can build a postmarkapp.com like email-to-webhook service using ifttt alone. Wordpress seems to be the only channel on ifttt that supports custom domains, and hence can be used as a middleware.

#Payload The following information is passed along by the webhook in the raw body of the post request in json encoded format.

{
	user: "username specified in ifttt",
	password: "password specified in ifttt",
	title: "title generated for the recipe in ifttt",
	categories:['array','of','categories','passed'],
	description:"Body of the blog post as created in ifttt recipe"
}

To get the data from the POST request, you can use any of the following:

$data = json_decode(file_get_contents('php://input')); #php
data = JSON.parse(request.body.read) #ruby-sinatra

Testing

GitHub has a handy guide for testing webhooks than you might find useful: https://help.github.com/articles/testing-webhooks

#Licence Licenced under GPL. Some portions of the code are from wordpress itself. You should probably host this on your own server, instead of using ifttt.captnemo.in. I recommend using phpfog for excellent php hosting.

#Custom Use Just clone the git repo to some place, and use that as the wordpress installation location in ifttt.com channel settings.

#About this Fork This is a modification of the original repo https://github.com/captn3m0/ifttt-webhook created by Captn3mo, made by Marcus Povey http://www.marcus-povey.co.uk.