Code Monkey home page Code Monkey logo

loupedeck.webhooksplugin's Introduction

Webhooks Loupedeck Plugin

License forks stars issues downloads

There is seemingly no built-in way to trigger a "call-and-forget" webhook within the native Loupedeck application.

The Webhooks Loupedeck Plugin corrects the obvious omission of fundamental functionality in a macro controller.

Credits

This plugin makes heavy use of HarSharp, and its dependancies.


Table of Contents

Installation

Loupedeck Installation
  1. Go to latest release, and download the lplug4 file to you computer
  2. Open (normally double-click) to install, the Loupedeck software should take care of the rest
  3. Restart Loupedeck (if not handled by the installer)
  4. In the Loupedeck interface, enable Webhooks by clicking Manage plugins
  5. Check the Webhooks box on to enable
  6. Drag the desired control onto your layout

Once click it will bring you to a dynamic playback device selection page.

IDE Installation Made with Visual Studio 2022, C# will likely only compile in VS2019 or greater.

Assuming Loupedeck is already installed on your machine, make sure you've stopped it before you debug the project.

Debugging should build the solution, which will then output the DLL, config, and pdb into your %LocalAppData%\Loupedeck\Plugins directory.

If all goes well, Loupedeck will then open and you can then debug.

Usage

Follow the Loupedeck Installation instructions above.

You will need to familiarize yourself with HAR/Http Archive files. They're effectively just JSON files with specific schema for HTTP requests and their responses.

There are numerous ways to create them, or export them in many different applications. Including Postman, Telerik Fiddler2, and even most browsers DevTools will allow you to export/copy web requests as HARs.

An example HAR file for a fake IFTTT call can be found here: example.har

All HAR Files must be saved to %userprofile%/.loupedeck/webhooks (Windows) -OR- ~/.loupedeck/webhooks (Mac)

You can have multiple *.har files with multiple requests, or one .har with all the requests. The plugin will treat them the same.

Fields that deal in "size" or "times" can be set to 0. They're not used in the creation/execution of the requests.

Once completed you will be able to add requests to the Webhook actions "Requsts" folder in the Loupedeck UI.

  1. Simply click the [+] button on the same row
    1. Skip the name it just gets clobbered the moment you select a hook
  2. Select HTTP Method (you will only available ones from your HAR files)
  3. Select Hook from the final dropdown and click Save

The button generation leads a lot to be desired, I apologize. I personally just create a macro and drag it in as an action step.

Support

Submit an issue

Fill out the template to the best of your abilities and send it through.

Contribute

Easily done. Just open a pull request.

Don't worry about specifics, I'll handle the minutia.

License

The MIT-License for this plugin can be reviewed at LICENSE attached to this repo.

loupedeck.webhooksplugin's People

Contributors

steinerd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

loupedeck.webhooksplugin's Issues

Installation in MacOS hangs w/ error (cosmetic)

Version
1.0.1 Alpha
Submitting a...

  • Bug report
  • Feature request

Current behavior:
The application installs in MacOS, but Loupedeck locks up, and an error message is shown underneath the installation window suggesting to re-launch the Loupedeck application.

Expected behavior:
the application installs w/o an error message

Steps to reproduce:
Clean install of Loupedeck current version
double-click the plug-in file to install

Other information:
after force-closing the Loupedeck application and re-launching, it looks like the webhook plugin was successfully installed.

Webhooks doesn't appear

1.0.9
Hi there, I'm installed okay (as you can see the plugin is active and activated), however nothing appears when I click + on a button, also there are no actions appear on the right under webhooks (I've put your example.har file in my system)

Loupedeck Configuration 2022-12-16 18 30 18

Incorrect User Profile Directory on MacOS

Version
1.0.1 Alpha

Submitting a...

  • Bug report
  • Feature request

Current behavior:
installing the plugin creates a %userprofile% directory called ".loupedeck\webhooks" Please note, this is not a directory + subdirectory; the single directory is actually called ".loupedeck\webhooks." In order to change to that directory in a terminal, it looks like this:
user@mbp15-wifi[~]: cd .loupedeck\webhooks
user@mbp15-wifi[.loupedeck\webhooks]:

Expected behavior:
it should look like this: cd .loupedeck/webhooks

Steps to reproduce:
install plugin
open terminal
ls -la
see the incorrect directory name

Other information:
It DOES work, however, you just need to copy the .har files to ~/.loupedeck\webhooks in order for it to find and parse the .har files.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.