Entity Alert
Retrieve alerts for a specific entity.
The API key for authentication
test
The Id of the user performing the request.
dummy-userid
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/alerts HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"success": true,
"alerts": [
{
"alertId": "alert-id",
"entityId": "e-example-id",
"name": "text",
"alertType": "ALERT_TYPE_QUEST_START",
"destination": "SlACK",
"webhookURL": "text",
"isEnabled": true,
"createdAt": "2025-06-26T11:53:27.877Z"
}
]
}
Add an alert for a specific entity.
The ID of the entity.
The API key for authentication
test
The token for user authentication.
dummy-token
The Id of the user performing the request.
dummy-userid
The type of alert.
The destination for the alert (SLACK, CUSTOM_BACKEND, EMAIL, UNKNOWN).
The webhook URL for the alert.
POST /api/entities/{entityId}/alerts HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
userid: dummy-userid
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"alertType": "ALERT_TYPE_QUEST_START",
"destination": "SLACK",
"webhookURL": "https://example.com/slack-webhook"
}
{
"success": true,
"alertId": "text"
}
Update an existing entity alert.
The API key for authentication
test
The token for user authentication.
dummy-token
The Id of the user performing the request.
dummy-userid
The updated type of alert.
The updated destination for the alert (SLACK, CUSTOM_BACKEND, EMAIL, UNKNOWN).
The updated webhook URL for the alert.
POST /api/entities/{entityId}/alerts/{alertId}/update HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
userid: dummy-userid
Content-Type: application/json
Accept: */*
Content-Length: 111
{
"alertType": "ALERT_TYPE_QUEST_UPDATED",
"destination": "EMAIL",
"webhookURL": "https://example.com/email-webhook"
}
{
"success": true
}
Disable an existing entity alert.
The ID of the entity.
The ID of the entity alert.
The API key for authentication
test
The token for user authentication.
dummy-token
The Id of the user performing the request.
dummy-userid
POST /api/entities/{entityId}/alerts/{alertId}/disable HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
userid: dummy-userid
Accept: */*
{
"success": true
}
Enable an existing entity alert.
The ID of the entity.
The ID of the entity alert.
The API key for authentication
test
The token for user authentication.
dummy-token
The Id of the user performing the request.
dummy-userid
POST /api/entities/{entityId}/alerts/{alertId}/enable HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
userid: dummy-userid
Accept: */*
{
"success": true
}
Last updated