Entity Alert

Get entity alerts

get

Retrieve alerts for a specific entity.

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/alerts' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

500

200

{
  "success": true,
  "alerts": [
    {
      "alertId": "alert-id",
      "entityId": "e-example-id",
      "name": "text",
      "alertType": "UNKNOWN",
      "destination": "SLACK",
      "webhookURL": "text",
      "isEnabled": true,
      "createdAt": "2025-04-03T03:43:59.558Z"
    }
  ]
}

Successful response

Add Entity Alert

post

Add an alert for a specific entity.

Path parameters

entityIdstringrequired

The ID of the entity.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Body

alertTypestringoptional

The type of alert.

destinationstringoptional

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

webhookURLstringoptional

The webhook URL for the alert.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/alerts' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid' \
  --header 'Content-Type: application/json' \
  --data '{
    "alertType": "ALERT_TYPE_QUEST_START",
    "destination": "SLACK",
    "webhookURL": "https://example.com/slack-webhook"
  }'

200

400

500

200

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

Successful operation

Update Entity Alert

post

Update an existing entity alert.

Path parameters

entityIdstringrequired

alertIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Body

alertTypestringoptional

The updated type of alert.

destinationstringoptional

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

webhookURLstringoptional

The updated webhook URL for the alert.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/update' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid' \
  --header 'Content-Type: application/json' \
  --data '{
    "alertType": "ALERT_TYPE_QUEST_UPDATED",
    "destination": "EMAIL",
    "webhookURL": "https://example.com/email-webhook"
  }'

200

400

500

200

{
  "success": true
}

Successful operation

Disable Entity Alert

post

Disable an existing entity alert.

Path parameters

entityIdstringrequired

The ID of the entity.

alertIdstringrequired

The ID of the entity alert.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/disable' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid'

200

400

500

200

{
  "success": true
}

Successful operation

Enable Entity Alert

post

Enable an existing entity alert.

Path parameters

entityIdstringrequired

The ID of the entity.

alertIdstringrequired

The ID of the entity alert.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/alerts/{alertId}/enable' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid'

200

400

500

200

{
  "success": true
}

Successful operation