Entity Alert

Get entity alerts

Retrieve alerts for a specific entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/alerts

Path parameters

entityId*string

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

alertsarray of EntityAlert (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/alerts', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

200400500

{
  "success": true,
  "alerts": [
    {
      "alertId": "alert-id",
      "entityId": "e-example-id",
      "name": "text",
      "alertType": "UNKNOWN",
      "destination": "SLACK",
      "webhookURL": "text",
      "isEnabled": true,
      "createdAt": "2025-01-18T01:45:50.125Z"
    }
  ]
}

Add Entity Alert

Add an alert for a specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/alerts

Path parameters

entityId*string

The ID of the entity.

Header parameters

Body

application/json

The details of the alert.

alertTypestring

The type of alert.

destinationstring

The destination for the alert (SLACK, CUSTOM_BACKEND, EMAIL, UNKNOWN).

webhookURLstring

The webhook URL for the alert.

Response

200400500

Successful operation

Body

application/json

successboolean

alertIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/alerts', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "alertType": "ALERT_TYPE_QUEST_START",
      "destination": "SLACK",
      "webhookURL": "https://example.com/slack-webhook"
    }),
});
const data = await response.json();

Response

200400500

{
  "success": true,
  "alertId": "text"
}

Update Entity Alert

Update an existing entity alert.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/update

Path parameters

entityId*string

alertId*string

Header parameters

Body

application/json

The updated details of the alert.

alertTypestring

The updated type of alert.

destinationstring

The updated destination for the alert (SLACK, CUSTOM_BACKEND, EMAIL, UNKNOWN).

webhookURLstring

The updated webhook URL for the alert.

Response

200400500

Successful operation

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/update', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "alertType": "ALERT_TYPE_QUEST_UPDATED",
      "destination": "EMAIL",
      "webhookURL": "https://example.com/email-webhook"
    }),
});
const data = await response.json();

Response

200400500

{
  "success": true
}

Disable Entity Alert

Disable an existing entity alert.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/disable

Path parameters

entityId*string

The ID of the entity.

alertId*string

The ID of the entity alert.

Header parameters

Response

200400500

Successful operation

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/disable', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid"
    },
});
const data = await response.json();

Response

200400500

{
  "success": true
}

Enable Entity Alert

Enable an existing entity alert.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/enable

Path parameters

entityId*string

The ID of the entity.

alertId*string

The ID of the entity alert.

Header parameters

Response

200400500

Successful operation

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/enable', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid"
    },
});
const data = await response.json();

Response

200400500

{
  "success": true
}