Developer documentation for using the Eurker uptime monitoring API and dashboard.
API key creation is not available until version 3. For now, the API is accessible only through the dashboard.
Monitors can be created via the dashboard. Required inputs:
Method
Either http or keyword
URL
Target domain or endpoint (e.g. google.com)
Timeout
Check interval: 1, 2, or 4 minutes
Advanced Config
Optional JSON for fine-tuned control
Define custom headers, request body, webhook behavior, assertions, and more using JSON.
Advanced config is validated with the following rules:
method GET, POST, PUT, DELETE
headers Only allowed headers. Authorization is encrypted.
body Must be valid JSON under 2MB
requestTimeout Between 100 and 10000 ms
retries Max 5
followRedirects, failedCallRepeat, enabled Must be booleans
tags Up to 10 tags, total max 200 characters
onSuccessWebhook / onFailureWebhook HTTPS URLs only, no localhost
assert Required for keyword monitors: Must include assert.keyword and assert.failIfFound
Upgraded accounts unlock additional features:
Max Monitors
Free 5
Upgraded 50
Alert Methods
Free 1 (Emaik, Slack, SMS)
Upgraded Up to 8 (Email, Slack, SMS)
Custom HTTP Methods
Free GET only
Upgraded GET, POST, PUT, DELETE
Custom Headers
Free No
Upgraded Yes
Request Body
Free No
Upgraded Yes
Webhooks
Free Disabled
Upgraded onSuccess / onFailure
If configured in advancedConfig, your onSuccessWebhook or onFailureWebhook URL will receive a POST request with the following JSON body:
Success Payload Example:
Failure Payload Example:
You can use this data to trigger your own alerting workflows, logging, or dashboards. The webhook must be publicly accessible and accept POST requests with a Content-Type: application/json header.
400 Bad Request: Invalid or missing input403 Forbidden: Feature restricted to upgraded plan429 Too Many Requests: Rate limit exceeded500 Internal Server Error: Something went wrongsupport@eurker.com