Tools to Capture and Convert the Web

Handler with Ruby

Ruby API


Having problems debugging your handler? Try the Callback Handler Test Tool.

The handler described here processes callbacks from the GrabzIt screenshot web service. The URL of this handler is passed to GrabzIt in the callBackURL parameter of the save method. However this technique will only work if the handler is accessible via the Internet.

The following parameters are passed to the handler as GET parameters.

  • id - the unique identifier of the screenshot, used by the get_result method
  • filename - the filename of the screenshot, automatically created by combining the screenshot's unique identifier with it's file extension
  • message - any message due to an error caused during the processing of the screenshot
  • customId - any custom id that was passed to the GrabzIt web service via the save method
  • format - the format of the screenshot, e.g "bmp8", "bmp16", "bmp24", "bmp", "csv", "gif", "jpg", "json", "pdf", "png", "tiff", "webp" or "xlsx"
  • targeterror - if a 1 is returned then the capture contains a generic error, due to an issue caused by the capture target

If you want to block all access to the handler, except from GrabzIt then use this security technique.


Remember this callback will not work if your application is located on localhost.

This example shows how a GrabzIt Ruby handler can be implemented. This captures five parameters passed to it from the GrabzIt service, including the unique id of the screenshot which is passed to the get_result method.

This method then returns the screenshot, which is saved in the screenshot directory. However if a nil value is returned from the get_result method this indicates that an error has occured.

require 'grabzit'

class HandlerController < ApplicationController
  def index
	  message = params[:message]
	  customId = params[:customid]
	  id = params[:id]
	  filename = params[:filename]
	  format = params[:format]
      targetError = params[:targeterror]
	  grabzItClient ="Sign in to view your Application Key", "Sign in to view your Application Secret")
	  result = grabzItClient.get_result(id)
	  if result == nil

	  # Ensure that the application has the correct rights for this directory.  
	  screenshot ="public/screenshots/"+filename, "wb")