Hooks

2min
What are hooks? 
hooks is a mechanism you can use to send the events that occur within hyper63 to an external service for review and observability. For example, if you use a centralized logging service or a data warehouse.
How do I setup hooks?
﻿
First you need to install the hooks adapter:
﻿
Shell
npm install @hyper63/adapter-hooks


npm install @hyper63/adapter-hooks

﻿
﻿
In the hyper63.config.js file you attach your hooks adapter to the hooks port.
JS
const hooks = require('@hyper63/adapter-hooks')

module.exports = {
    ...,
    adapters: [
      ...,
      { port: 'hooks', plugins: [
          hooks([{
            matcher: '*',
            target: 'https://metrics.hyper63.com'
          }])
      ]}
    ]
}
const hooks = require('@hyper63/adapter-hooks')

module.exports = {
    ...,
    adapters: [
      ...,
      { port: 'hooks', plugins: [
          hooks([{
            matcher: '*',
            target: 'https://metrics.hyper63.com'
          }])
      ]}
    ]
}
﻿
With the @hyper63/adapter-hooks you provide an array of objects which represent the hooks you want to add. Each hook requires a matcher to match the events you want to capture, then a target. The target is the url that a POST method will fire sending the payload of the event, which includes the name of the port, the name of the action, the date and time the event occured and the subject who invoked the command and the identifier if available of the entity that was affected by the command.
Updated 03 Mar 2023
Did this page help you?
Middleware
Deploy
Docs powered by Archbee
TABLE OF CONTENTS
What are hooks?
How do I setup hooks?