Webhooker-SDK-nodejs

Simplify your webhook distribution infrastructure to a single line of code.

Installation and guides are available in the docs

Quick Start

Install from npm: npm install --save webhooker-client
Require the module and create a client:

const Webhooker = require('webhooker-client')
const client = Webhooker.withKey('My Key')

Send a message to your subscribers:

client.send({ 
	tenant: 'account.1', 
	type: 'task.created', 
	payloads: { 
		json: { id: 123, name: 'foo' },
	},
})

API

Classes

WebhookerClient: The API client used to send requests to the webhooker api
Config
Message: Represents a message sent within the Webhooker system
SignedMessage ⇐ `Message`: Represents a message within the webhooker system that should generate signatures when sending to the API

Typedefs

WebhookerCallback : function: The callback provided to methods that utilise the Webhooker api. When a WebhookerCallback is accepted, it can instead be omitted to cause the called function to return a Promise
MessageObject : Object: An easily constructed version of the MessagePayload object using a js-native naming scheme for payloads, as compared to the request body names. This type will usually be the one accepted by the public API, and MessagePayload will usually be the type used internally
MessagePayload : Object: The body parameters for a WebhookerClient send request
TenantKey : string: The non-unique user specified identifier for a single subsciption endpoint. Multiple subscriptions can have the same tenant key, and a request will be sent to all subscriptions that have tenant keys matching the one specified with the API request

WebhookerClient

The API client used to send requests to the webhooker api

Kind: global class

WebhookerClient
- new WebhookerClient(config)
- instance
  - .send(message, [callback]) ⇒ Promise
- static
  - .withKey(apiKey)

new WebhookerClient(config)

Create a new Webhooker client.

Param	Type	Description
config	`Config`	A config object that provides API information to the client. Can be used to customise the domain, in case it differs from the standard webhooker api

webhookerClient.send(message, [callback]) ⇒ Promise

Send a message payload to Webhooker, which will then send the payload to the matching subscribers

Kind: instance method of WebhookerClient
Returns: Promise - A promise that will resolve when the request has completed. If there was an error, the promise will be rejected. Otherwise it will be resolved with the server response. Only returned when callback is null or undefined

Param	Type	Description
message	`Message` / `MessageObject`
[callback]	`WebhookerCallback`	A callback that will be triggered when the request has completed. If this is omitted, the function will instead return a promise

WebhookerClient.withKey(apiKey)

Create a new Webhooker client with default parameters and the specified api key

Kind: static method of WebhookerClient

Param	Type
apiKey	string

Config

Kind: global class

Config
- new Config(apiKey, domain)
- .withKey(apiKey)

new Config(apiKey, domain)

Create a new configuration object

Param	Type	Description
apiKey	string	The api key to send with webhooker requests
domain	string	The domain name to send webhooker requests to

Config.withKey(apiKey)

Create a new configuration object with the default webhooker domain

Kind: static method of Config

Param	Type	Description
apiKey	string	The api key to send with webhooker requests

Message

Represents a message sent within the Webhooker system

Kind: global class

Message
- new Message(id, tenant, type, payloads, [signatureType])
- instance
  - .id(id) ⇒ Message
  - .tenant(tenant) ⇒ Message
  - .type(type) ⇒ Message
  - .json(json) ⇒ Message
  - .xml(xml) ⇒ Message
  - .isSent() ⇒ boolean
  - .toPayload() ⇒ MessagePayload
- static
  - .XML_KEY
  - .JSON_KEY
  - .from(params) ⇒ Message
  - .builder() ⇒ Message

new Message(id, tenant, type, payloads, [signatureType])

Create a new message

Param	Type	Default	Description
id	string / null		The message identifier. Can be null for unsent messages
tenant	`TenantKey`		The tenant key that will be used to filter this message
type	string		The event name/type that this message will be sent as
payloads	Object		An object containing the payloads to send
[payloads.json]	string / Object / Array		The string encoded json body, or an object to be serialised
[payloads.xml]	string		The string encoded xml body
[signatureType]	string / false	`"'SHA256'"`