Protocol implementation of the webhookify client protocol. The specification of the protocol can be found on the wiki.
Installation
Install the protocol stack by running
npm i -S webhookify
Usage
// load moduleconst Protocol = ; // load private key and client id from somewherelet clientId privateKeyPEM; // instantiate protocollet connection = client privateKeyPEM; // connect to serverconnection; // handle incoming eventsconnection; connection; connection;
Reference
class Protocol
constructor(clientId, privateKeyPem, options)
Creates a new instance of the protocol. A valid clientId can be retrieved at https://www.webhookify.net and a valid private RSA key can be generated with the client or openssl for example.
The options parameter is an object with the following recognized keys:
reconnect
(boolean) [Default: true
]
reconnectDelay
(number) [Default: 2000
]
ignoreErrors
(boolean) [Default: true
]
connect()
Initiates a connection to the webhookify server.
All other methods are for internal use only, but they might be useful, if you plan on extending this class somehow
processMessage(message)
Parses the message string and invokes the appropriate action, either replying to the challenge or emitting a "push" or "fetch" event.
sendReply(id, payload)
Encodes id and payload into a reply message, which is then sent to the server via the websocket connection.
sendError(id, err)
Encodes id and err.message
into an error message, which is then sent to the server via the websocket connection.
encodeMessage(type, id, payload)
Creates a new message string with the specified parameters.
Events
Event 'push'
A push message was received from the server.
The handler is called with (plugin, payload).
Event 'fetch'
A fetch message was received from the server, which now expects a reply within five seconds.
The handler is called with (plugin, payload, reply), where reply is a function with the signature (err, response).
Event 'connected'
The websocket connection is (re-)established.
Event 'disconnected'
The websocket connection was interrupted for some reason.
Event 'error'
If the ignoreErrors
option is set to false
, the error events the socket encounters are passed on here.