Core
Using the NPM Core Package
The Core setup will allow you to use the core methods to access the service API.
AbyssMonitorCore.setConfig({
// Your Application Monitor API Key
applicationApiKey: "application-monitor-api-key",
// Your Application ID
applicationId: "application-id",
// Name showed on alerts
applicationName: 'My Super Application - API',
// This method should return an URl to post Alert
// You can return null/undefined if you want to not send alert
// Please check complete typing of payload on the Core Package
async getWebhookUrl(payload) {
return "my-discord-webhook-url";
},
// Can be found on your AbyssMonitor dashboard
// It's required to publish log remotely
secretPublishToken: "secret-publish-token",
});
// This method will enable automatic retry on failed http request to AbyssMonitor API
AbyssMonitorCore.enableAxiosRetry();
Standalone
If you are not using the NPM package to access the API, you can skip this step and just set your API key on the HTTP request header.
// HTTP Version
GET /api/user/me HTTP/1.1
Host: monitor-api.abyss-project.fr
abyss-monitor-api-key-application: "abyss-monitor-api-key-application"
// Curl Version
curl --location 'https://monitor-api.abyss-project.fr/api/user/me' \
--header 'abyss-monitor-api-key-application: abyss-monitor-api-key-application'
Last updated