Creating a Scheduled Plugin Service View on Github

Our goal – in order to know which items are on the todo list for today, we will fetch records from Zengine and post them to HipChat once a day. We will accomplish this by combining a backend plugin service with scheduled webhooks. Our backend service will fetch records and post them to HipChat. Our scheduled webhook will then run once a day to execute the backend service. If you aren’t yet familiar, we recommended first reading about backend services.


You will need a HipChat account with API access to send messages. Create an API token for “Send Message”.

Creating the Plugin Service

If you haven’t done so already, start by creating a plugin and adding a backend service using the Developer tools. Next, download and extract the default draft source. Edit the plugin.js file and replace the contents with the following code:

// Plugin code goes here
var znHttp = require('./lib/zn-http'),
	requestify = require('requestify'); = function(eventData) {

	// Scheduled Webhooks use POST
	if (eventData.request.method === 'POST') {

		var formId = eventData.request.query.formId,
			folderId = eventData.request.query.folderId || 0,
			hipchatRoom = eventData.request.query.hipchatRoom,
			hipchatToken = eventData.request.query.hipchatToken,
			scheduledData =;

		znHttp().get('/forms/' + formId + '/records?' + folderId).then(function(response) {

			var body = response.getBody(),
				records =,
				message = [];

			message.push('Scheduled @ ' + scheduledData.scheduled);

			records.forEach(function(record) {
				message.push( + ' - ' +;

			message.push('Next Scheduled @ ' + scheduledData.nextScheduled);

			message = message.join("\n");'' + hipchatRoom + '/message?auth_token=' + hipchatToken, {
				message: message
			}).then(function() {
				// return message
			}, function(error) {

		}, function(error) {
	} else {
		eventData.response.status(404).send('Not found');


The above code will take several query string parameters to fetch records and then post them to HipChat. Scheduled webhooks will then send a POST to your service, containing data such as when the webhook was scheduled to run and when the webhook is next scheduled to run. The above code will look for this data and include it in the message it sends to HipChat.

Once you have updated plugin.js, zip the updated plugin folder and upload it back to your plugin service.

Publish and Install

Once your plugin service has been updated, you will need to publish and install it into the workspace where it should run. When publishing your plugin, make sure to enable offline access so that it can fetch your records when the webhook executes.

After publishing, install and activate the plugin in your workspace.

Creating a Scheduled Webhook

Now that you have a plugin service, you can create a scheduled webhook to execute it. Create a scheduled webhook with the where you installed your plugin, a frequency of daily, and a URL in the format{workspaceId}/{pluginNamespace}/{serviceRoute}?formId={formId}&folderId={folderID}&hipchatRoom={room}&hipchatToken={token}

You must specify a formId, hipchatRoom, and the hipchatToken that you created under prerequisites. You can optionally specify a folderId to fetch a subset of records, for instance, only records in a “To Do” folder, ignoring records in a “Completed” folder.

If you do not specify a start datetime, then it will start running immediately and will run daily at that time.

Once the scheduled webhook executes your plugin service, you should see results like this posted in your HipChat room:

Scheduled @ 2015-09-23 21:00:00
866936 - Frontend Interface
866937 - Backend API
866938 - Documentation
Next Scheduled @ 2015-09-24 21:00:00