1.0.0 • Published 1 year ago

hostedhooks-node v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

HostedHooks Nodejs Library

A Nodejs library for HostedHooks, a Webhooks as a Service Platform.

Installation

npm install --save hostedhooks-node

How it works

Import

// CommonJS
const { HostedHooks } = require("hostedhooks-node")

// ESM
import { HostedHooks } from "hostedhooks-node"

Authentication

Create an object with your API key that is found here.

const client = new HostedHooks("HOSTEDHOOKS_API_KEY")

Get one record

client.get_endpoint("endpoint_uuid")

Get a collection of records

client.list_subscriptions("app_uuid")

Create a record

client.create_app({ name: "Test App Name" })

Update a record

client.update_app("app_uuid", { name: "Test App Name" })

Resources

  • Apps
  • Subscriptions
  • Endpoints
  • Webhook Events
  • Messages

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hostedhooks-node. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the Hostedhooks Nodejs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

License

The library is available as open source under the terms of the MIT License.