https://github.com/domapic/webhook-domapic-module
Domapic module for triggering a webhook
https://github.com/domapic/webhook-domapic-module
domapic domotic iot request rest-api webhook
Last synced: 3 months ago
JSON representation
Domapic module for triggering a webhook
- Host: GitHub
- URL: https://github.com/domapic/webhook-domapic-module
- Owner: domapic
- License: mit
- Created: 2018-12-08T17:20:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-06T11:40:06.000Z (over 6 years ago)
- Last Synced: 2024-12-27T06:09:04.849Z (5 months ago)
- Topics: domapic, domotic, iot, request, rest-api, webhook
- Language: JavaScript
- Size: 238 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Webhook Domapic Module
> Domapic Module for triggering a webhook.
[![Build status][travisci-image]][travisci-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Quality Gate][quality-gate-image]][quality-gate-url] [![js-standard-style][standard-image]][standard-url]
[![NPM dependencies][npm-dependencies-image]][npm-dependencies-url] [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url]
[![NPM downloads][npm-downloads-image]][npm-downloads-url] [![License][license-image]][license-url]
---
## Intro
This package starts a Domapic Module that with ability called "webhook" that make a request to a certain url.
It can be used alone, but also can be connected to a [Domapic Controller][domapic-controller-url] to get the most out of it.
## Installation
```bash
npm i webhook-domapic-module -g
```
## Start the server
```bash
domapic-webhook start --url=http://foo-domain.com/api/trigger-webhook --method=POST --save
```
The server will be started in background using [pm2][pm2-url].
To display logs, type:
```bash
domapic-webhook logs #--lines=300
```
## Options
The module, apart of all common [domapic services options][domapic-service-options-url], provides custom options for configuring the webhook:
* `url` - Url of the webhook to be triggered.
* `method` - HTTP method to use when requesting the webhook url. Can be `GET` or `POST`
## Connection with Domapic Controller
Connect the module with a Domapic Controller providing the Controller url and connection token (you'll find it the Controller logs when it is started):
```bash
domapic-webhook start --controller=http://192.168.1.110:3000 --controllerApiKey=fo--controller-api-key
```
Now, the module can be controlled through the Controller interface, or installed plugins.
## Stand alone usage
Domapic modules are intended to be used through Domapic Controller, but can be used as an stand-alone service as well. Follow next instructions to use the built-in api by your own:
### Rest API
When the server is started, you can browse to the provided Swagger interface to get all the info about the api resources. Apart of all api methods common to all [Domapic Services][domapic-service-url], the server provides one [_Domapic Ability_][domapic-service-abilities-url] for triggering the webhook, which generates one extra API resource:
* `/api/abilities/webhook/action` - Trigger the webhook. Will return a 502 status code when webhook service fails.
### Authentication
The server includes the [Domapic Services][domapic-service-url] authentication method, which is disabled by default for `127.0.0.1`.
You can disable the authentication using the `--authDisabled` option (not recommended if your server is being exposed to the Internet). Read more about [available options in the domapic services documentation][domapic-service-options-url].
If you want to authenticate when requesting from another IPs, look for the api key automatically generated and intended to be used by Domapic Controller when the server is started. You'll find it in the server logs:
```
-----------------------------------------------------------------
Try adding connection from Controller, using the next service Api Key: HMl6GHWr7foowxM40CB6tQPuXt3zc7zE
-----------------------------------------------------------------
```
To make your own requests to the api, provide this token using the `X-Api-Key` header.
Use the mentioned api key also for authenticating when using the Swagger interface.
## Alternative command line methods
### Not global installation
If the package is not installed globally, you can replace the `domapic-webhook` command in examples above by `npm run domapic-webhook --` (commands must be executed inside the package folder in that case)
### Not background mode
If you don't want to use the built-in background runner, you can start the server directly, attaching logs to current `stdout`. Move to the package folder and replace the `domapic-webhook` command of examples above by `node server.js`. Press `CTRL+C` to stop the server.
[coveralls-image]: https://coveralls.io/repos/github/javierbrea/webhook-domapic-module/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/javierbrea/webhook-domapic-module
[travisci-image]: https://travis-ci.com/javierbrea/webhook-domapic-module.svg?branch=master
[travisci-url]: https://travis-ci.com/javierbrea/webhook-domapic-module
[last-commit-image]: https://img.shields.io/github/last-commit/javierbrea/webhook-domapic-module.svg
[last-commit-url]: https://github.com/javierbrea/webhook-domapic-module/commits
[license-image]: https://img.shields.io/npm/l/webhook-domapic-module.svg
[license-url]: https://github.com/javierbrea/webhook-domapic-module/blob/master/LICENSE
[npm-downloads-image]: https://img.shields.io/npm/dm/webhook-domapic-module.svg
[npm-downloads-url]: https://www.npmjs.com/package/webhook-domapic-module
[npm-dependencies-image]: https://img.shields.io/david/javierbrea/webhook-domapic-module.svg
[npm-dependencies-url]: https://david-dm.org/javierbrea/webhook-domapic-module
[quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=webhook-domapic-module&metric=alert_status
[quality-gate-url]: https://sonarcloud.io/dashboard?id=webhook-domapic-module
[release-image]: https://img.shields.io/github/release-date/javierbrea/webhook-domapic-module.svg
[release-url]: https://github.com/javierbrea/webhook-domapic-module/releases
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[domapic-controller-url]: https://www.npmjs.com/package/domapic-controller
[domapic-service-options-url]: https://github.com/domapic/domapic-service#options
[domapic-service-abilities-url]: https://github.com/domapic/domapic-service#abilities
[domapic-service-url]: https://github.com/domapic/domapic-service
[pm2-url]: http://pm2.keymetrics.io/