Documentation

API endpoints & Server monitoring installation

Notyfi.Co keeps you informed—nothing more, nothing less.

  • Created: (15 Mar, 2025)
  • Update: (15 Mar, 2025)

If you have any questions that are beyond the scope of this help file, Please feel free to email via info@notyfi.co.

Server monitoring Installation

Notyfi.co service monitoring reference:
Github repository: Notyfi.co Monitoring

Follow the steps below to setup your monitoring:

  1. Below is the folder structure and needs to be uploaded to your server
    • git clone https://github.com/skotow/notyfico_monitoring.git - Contains all the installable
      • cd notyfico_monitoring - Enter directory
      • cp .env_example .env - Copy enviroment file
      • pip or pip3 install . - Install packages
      • python3 -m ensurepip --default-pip - run this command in case pip not found
        1. notyfico_monitor - To run monitoring
        2. notyfico_inline_msg - Notify when some task done in single line
  2. Modify .env for custom settings
  3. You are good to go for monitoring

notyfico_inline_msg You running some dns lookup or any other task just notify when is done with result:

Example: mt_task=$(nslookup 1.1.1.1) && notyfico_inline_msg "$mt_task" --tag reminder

Params: notyfico_inline_msg {your message} --tag {your_tag}- tag is optional

API Documentation

Notyfi.co has one endpoint to send notification with simple body request :
POST
https://api.notyfi.co/api/send_notify

  1. Body Parameters
    • Request url: https://api.notyfi.co/api/send_notify - endpoint
      • from - your username
      • to - username you want to notify or your group notifications tag
      • tag - label tag (optional)
      • message - Notification message
  2. Authentication headers parameter apikkey - API key
Authentication header parameter 
                        
{
    "apikkey": "{YOUR API KEY}"
}
Body request 
                        
{
    "from": "{your_username}",
    "to": "{to_username OR Notification_API_tag}",
    "tag": "{name_of_tag}", // Optional
    "message": "Your message here"
}
Example Request 
                        
curl -X POST "https://api.notyfi.co/api/send_notify" \
-H "Content-Type: application/json" \
-H "apikkey: YOUR_API_KEY" \
-d '{
    "from": "{your_username}",
    "to": "{to_username OR Notification_API_tag}",
    "tag": "alert_sales" - optional,
    "message": "Hello, this is a test notification!"
}'
Response: 
                        
{
    "status": "success",
    "message": "Notification sent successfully"
}

If you need more information, please contact us via: info@notyfi.co

FAQ

A FAQ is a list of frequently asked questions (FAQs) and answers on a particular topic.

Message label - allows you split your notification into different groups . For instate to show your notification as from your phone number you can mark it as from "Sales Monthly"
The whitelist sender table controls who can send notifications to your phone. In order prevent anyone to send notification to your device add phone number of contact to your Whitelist senders in dashboard. If the rule table is empty, anyone can send messages. Otherwise, only whitelisted numbers are allowed.
You can find your API key inside your profile Dashboard

Changelog

Look hear for feature changes

Version 1.0 (15 Mar, 2025)

Initial Release