website logo
⌘K
Introduction
Getting started
πŸ“Reference
Data API
Cache API
Search API
Storage API
Queue API
Crawler API
πŸ”‘Authentication
βœ”οΈConfiguration
⚑Contributing to hyper
πŸ”ŒBuilding your own adapter
Code of Conduct
hyper RFCs
Style Guide
Bugs
Before Submitting A Bug Report
Building your own plugin
API Clients
Build your own client πŸ› οΈ
hyper connect
NodeJS Client πŸš€
Deno Client πŸ¦•
Middleware
Hooks
🚒Deploy
Deploy hyper on Render
Deploy hyper on AWS
Deploy hyper on Digital Ocean
Deploy hyper on Google Cloud
Deploy hyper on Azure
πŸ“œChangelog
FAQ
πŸ“•Terminology
Parameters
What is REST?
What is JSON?
πŸ“˜Glossary
Docs powered byΒ archbeeΒ 
4min

Hooks

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
|

ο»Ώ

In the hyper63.config.js file you attach your hooks adapter to the hooks port.

JS
|

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 15 Mar 2022
Did this page help you?
Yes
No
UP NEXT
Deploy
Docs powered byΒ archbeeΒ 
TABLE OF CONTENTS
What are hooks?
How do I setup hooks?