photo-front/documentation/schemas/Webhook.markdown
Jaisen Mathai ba68b3d400 Adding documentation pages (empty) for Webhooks.
Adding schema definition for Webhooks.

Gh-183
2011-10-03 17:00:05 -07:00

1.2 KiB

Documentation

OpenPhoto, a photo service for the masses


What's a Webhook object for?

Webhooks allow each OpenPhoto instance to be programmable. Developers use webhooks to be notified of events so they can process them.

http://wiki.webhooks.org/w/page/13385124/FrontPage


Schema for a Action object

{
  id: (string),
  appId: (string),
  callback: (string),
  topic: (enum),
  verifyToken: (string),
  challenge: (string),
  secret: (string)
}

Schema description

  • id, base 36 value of a base 10 auto-incremented value
  • appId, A string identifing the application creating this entry
  • callback, URL to which the event information is POSTed
  • topic, An enumerated string with predefined values (i.e. photoupload, photoupdate, newcomment, etc.)
  • verifyToken, A string supplied by the subscriber not used for sync
  • challenge, A challenge string used in the verification process not used for sync
  • secret, An optional subscriber supplied secret for request signing