Captain Hook - Web hook server
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

13 lines
1.2 KiB

  1. # API Reference Documentation
  2. This guide hopefully will explain how the API works. Any method undocumented, you can assume it will return a 405 error. If you go to a page that doesn't exist, it will return a 404 error.
  3. ## Index
  4. * / "GET" -> A page designed for web users to go to in order to learn about creating hooks
  5. ## Hooks
  6. * /hook/ "GET" -> Returns a list of all hooks in json form
  7. * /hook/<hook_name> "GET" -> Does whatever your hook is configured to do on a GET. If nothing configured, return the hook in json form. If it doesn't exist, return 404
  8. * /hook/<hook_name> "POST" -> Does whatever your hook is configured to do on a GET. If nothing configured, return the hook in json form. If it doesn't exist, return 404
  9. * /hook/<hook_name> "PUT" -> Submit the hook parameters and this will create the hook if it doesn't exist, or update it if it does. (CURRENTLY NOT IMPLEMENTED)
  10. * /hook/<hook_name> "DELETE" -> Delete the hook if it exists, does nothing if it doesn't
  11. * /hook/<hook_name> "" -> Delete the hook if it exists, do nothing if it doesn't
  12. * /hook/<hook_name>/configure "GET" -> Gives the web friendly configuration page for your hook (CURRENTLY NOT IMPLEMENTED)