rexxars/imbo-http-hooks

Perform HTTP requests when Imbo events occur

1.0.0 2014-11-03 22:00 UTC

This package is auto-updated.

Last update: 2024-10-29 04:30:58 UTC


README

Fire HTTP requests when Imbo events occur

Usage

  • Require rexxars/imbo-http-hooks in your Imbo composer.json
  • Run composer install to install and set up autoloading
  • In your Imbo configuration file, under eventListeners, initialize the listener. Example:
<?php
return [
    'eventListeners' => [
        'httpHooks' => [
            'listener' => 'Rexxars\Imbo\HttpHookListener',
            'params' => [
                // Event name => URLs
                'images.post' => [
                    'http://some.url/new-image.php',
                    'http://some.url/analyze-image.php'
                ],
                'metadata.post' => [
                    'http://some.url/metadata-updated.php',
                ]
            ]
        ]
    ]
];

The URLs you provide to the listener will then receive a HTTP POST request every time the provided event is triggered. The POST body will contain information in the following format:

    'event' => 'images.post',
    'url' => 'http://some.imbo.install/users/someuser/images',
    'imageIdentifier' => 'some image identifier',
    'publicKey' => 'someuser',

With that information and a Imbo client, you can easily fetch the image, metadata or do other actions based on the information received.

License

MIT-licensed. See LICENSE.