Quest Protocol
  • Introduction
    • Welcome to Quest Protocol
    • Integrate & Partner with Quest
    • Use Cases
      • Creator Platforms
      • Gaming
      • NFT Marketplaces
      • Social Media DApps
      • DeFi
  • QUEST PLATFORM
    • Creating a Campaign
    • Audience Overview
    • User Profile
    • Discover Page
    • Perk Store
    • Integrations
    • Memberships
    • Segmentation & Targetting
    • AI Insights
  • QUEST PROTOCOL - SDKs & APIs
    • UI SDK Components
      • Embedded XP Points
      • Embedded in-dApp Guides
      • Embedded Web3 Search
      • Embedded Quests
    • Quest SDKs & APIs
      • User
      • Entity
      • Badge
      • Campaign
      • App Metric
      • Membership Card
      • Entity Tag
      • Membership Tier
      • Skill
      • Entity Credit Tier
      • Gem
      • Custom Reward
      • Entity Gem
      • Entity Alert
      • Entity Feature Flag
      • Entity Data contract
      • Entity Authentication Token
      • Event Metric Mapping
    • Data Engine
  • Website
  • Quest Thesis
Powered by GitBook
On this page
  1. QUEST PROTOCOL - SDKs & APIs
  2. Quest SDKs & APIs

Entity Alert

PreviousEntity GemNextEntity Feature Flag

Last updated 1 year ago

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
200
Successful operation
application/json
400
Invalid request
application/json
500
Server error
application/json
post
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 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
200
Successful operation
application/json
400
Invalid request
application/json
500
Server error
application/json
post
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
}
  • GETGet entity alerts
  • POSTAdd Entity Alert
  • POSTUpdate Entity Alert
  • POSTDisable Entity Alert
  • POSTEnable 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
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
get
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-06T00:28:53.492Z"
    }
  ]
}

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
200
Successful operation
application/json
400
Invalid request
application/json
500
Server error
application/json
post
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 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
200
Successful operation
application/json
400
Invalid request
application/json
500
Unauthorized error
application/json
post
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
}