> For the complete documentation index, see [llms.txt](https://magehook.gitbook.io/magehook/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://magehook.gitbook.io/magehook/master.md).

# Hook

Enables developers & administrators to build and throw webhooks to any micro-services outside of Magento. An extendable framework in the shape of a Magento module which acts as a base layer for all your webhook events.

### Help and Docs

* [Official website](https://github.com/wpoortman/magehook-hook)
* [Basic principles](https://en.wikipedia.org/wiki/webhook)
* [What are webhooks](https://zapier.com/blog/what-are-webhooks/)

### Composer requirement

```bash
composer require wpoortman/magehook
```

### Compatibility

|           | Open Source | Commerce |
| --------- | ----------- | -------- |
| ~~2.0.x~~ | ~~No~~      | ~~No~~   |
| ~~2.1.x~~ | ~~No~~      | ~~No~~   |
| ~~2.2.x~~ | ~~No~~      | ~~No~~   |
| 2.3.0     | Yes         | Yes      |
| 2.3.1     | Yes         | Yes      |
| 2.3.2     | Yes         | Yes      |
| 2.3.3     | Yes         | Yes      |
| 2.3.4     | Yes         | Yes      |
| 2.3.5     | Yes         | Yes      |

### Install

```bash
php bin/magento module:enable MageHook_Hook
php bin/magento setup:upgrade
```

Move into the backend of your Magento 2 installation and navigate through the main menu **Stores > Settings > Configuration** and open the **Services** tab. Click on the **MageHook** section and search for the **Active** option within the **General** group. MageHook will only work when this setting is turned on.

### Submodule version regulations

**x**.x.x | Major incrementation can be applied when one or more 'new' events are based or dependent on an updated major version of the MageHook\_Hook extension.

x.**x**.x | Minor incrementation can be applied when one or more new events are added to the package

x.x.**x** | Patch incrementation can be applied when one or more existing events were fixed or upgraded