https://github.com/nampdn/hukk

Portable webhook utilities for NodeJS micro-service
https://github.com/nampdn/hukk

javascript microservice nodejs webhook

Last synced: about 1 year ago
JSON representation

Portable webhook utilities for NodeJS micro-service

• Host: GitHub
• URL: https://github.com/nampdn/hukk
• Owner: nampdn
• License: mit
• Created: 2018-11-15T10:14:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T14:07:28.000Z (almost 2 years ago)
• Last Synced: 2024-04-18T09:39:14.145Z (almost 2 years ago)
• Topics: javascript, microservice, nodejs, webhook
• Language: TypeScript
• Homepage:
• Size: 2.99 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# hukk 

Portable webhook utilities for NodeJS micro-service

[![npm version](https://badge.fury.io/js/hukk.svg)](https://badge.fury.io/js/hukk) [![Build Status](https://travis-ci.com/nampdn/hukk.svg?branch=master)](https://travis-ci.com/nampdn/hukk)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnampdn%2Fhukk.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fnampdn%2Fhukk?ref=badge_shield)

## Installation

```bash

yarn add hukk

```

## Usage

### Create webhook server:

```javascript

import hukk from 'hukk'

// Register new hook object

hukk.register({

  endpoint: '/webhook',

  handle: (data) => {

    console.log(data)

  }

}) 

hukk.listen(3000, () => {

  console.log('Hook server listening on port 3000')

})

```

### Send hook to another server

```javascript

import {hukkup} from 'hukk'

const data = {bar: 'boo'}

hukkup({hostname: 'localhost', port: 3000, endpoint: '/webhook', data}, (err, data) => {

  if (err) {

    console.error(err)

  }

  console.log('Response: ', data) // {"body": {"bar": "boo"}}

})

```

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnampdn%2Fhukk.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fnampdn%2Fhukk?ref=badge_large)