Notifygram API allows you to integrate Telegram notifications in more complex ways than the integrations we provide out of the box.

Basics

All methods must be called using HTTPS. Arguments can be passed as GET or POST params. The response contains a JSON object, which will always contain a top-level boolean property ok, indicating success or failure. For failure results, the error property will contain a short machine-readable error code.

{ 
    "ok": true
}
{ 
    "ok": false,
    "error": "something_bad"
}

Send notification

Send notification to all users in project

[POST/GET] https://notifygram.org/api/v1

Request (api_key, api_token & message are required)

param value description
api_key string project API key
api_token string project token
message string notification text
show_project_name boolean
(1)
add #project_name at the beginning of message

Response (application/json)

response description
{ "ok": true } message successfully sent
{ "ok": false,
"error": "auth_fail" }
(api_token & api_project) isn't valid
{ "ok": false,
"error": "empty_message" }
empty message variable