Project Alert Notifications

Subgraph deployments do not support Project Alert Notifications

OnFinality Indexing Service provides a service where you can receive alerts on the health status of your SubQuery projects. This means you can be alerted in real-time when your project becomes unhealthy and you can quickly resolve the issue to avoid any impact to your users.

You can easily set up a webhook endpoint to receive alert notifications on the health status of your projects on the Alerting page inside of the Indexing Service. All you need to do is enter the URL of the endpoint that you would like us to send webhooks to (e.g. Slack, Telegram). For example, you can easily receive notifications in Slack by following this guide, or Discord by following this guide.

OnFinality Indexing Service makes POST requests to send these notifications to your specified endpoint as a JSON payload. You can then use these notifications to execute actions in your backend systems. The JSON payload is in the following format

JSON

{
  "event_type": "indexer_unhealthy", // Event Type enum
  "event_message": "The indexer service for [jamesbayly/transaction-list][primary] is now unhealthy",
  "text": "The indexer service for [https://explorer.subquery.network/subquery/jamesbayly/projects/transaction-list> ][primary] is now unhealthy", // A longer version of event_message that is compatible with Slack
  "project": "jamesbayly/transaction-list", // Project key
  "project_name": "Polkadot Transactions",
  "project_url": "https://explorer.subquery.network/subquery/jamesbayly/projects/transaction-list?stage=false",
  "slot": "primary" // Either primary or stage
}

We currently support the following event types.

Event Type	What will trigger the event
`block_sync_stalled`	The block height has stalled in the last 15 mins
`block_sync_recover`	The block height resumes syncing after a `block_sync_stalled` event
`indexer_unhealthy`	The Indexer service transitions to unhealthy
`indexer_healthy`	The Indexer service transitions to healthy status
`query_unhealthy`	The Query service transitions to unhealthy
`query_healthy`	The Query service transitions to healthy status
`deployment_started`	A deployment starts
`deployment_success`	A deployment succeeds
`deployment_failed`	A deployment fails