Update an alert by ID

Alerts

PUT

https:/api.livesession.io/v1/alerts/{id}

Update alert by ID

Scopes

Required scopes: alerts:write

Path parameters

id
string
Required
Unique identifier of the alert to update

Request body

name
string
New name for the alert
events
array of object
Updated list of events that will trigger the alert
- kind
  integer
  Kind of event, more info [here](/docs/api/rest/EventKind)
- value
  string
  Value or threshold that triggers the alert
provider
enum
Updated notification provider for the alert
- slack
  string
- webhooks
  string
slack_channel_id
string
Updated Slack channel ID for notifications
webhook_id
string
Updated webhook ID for notifications

Response

alert_id
string
Unique identifier for the alert
name
string
Name of the alert
events
array of object
List of events that trigger the alert
- kind
  integer
  Kind of event, more info [here](/docs/api/rest/EventKind)
- value
  string
  Value or threshold that triggers the alert
provider
enum
Notification provider for the alert
- slack
  string
- webhooks
  string
slack_channel_id
string
Slack channel ID for notifications
webhook_id
string
Webhook ID for notifications
enabled
boolean
Whether the alert is currently active
creation_date
string
ISO 8601 timestamp when the alert was created

Example request

curl --request PUT \
     --url https://api.livesession.io/v1/alerts/string \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "name": "string",
  "events": [
    {
      "kind": 0,
      "value": "string"
    }
  ],
  "provider": "slack",
  "slack_channel_id": "string",
  "webhook_id": "string"
}
'

Example response

{
  "alert_id": "string",
  "name": "string",
  "events": [
    {
      "kind": 0,
      "value": "string"
    }
  ],
  "provider": "slack",
  "slack_channel_id": "string",
  "webhook_id": "string",
  "enabled": true,
  "creation_date": "string"
}

Create an alert Delete an alert by ID

Built with

Show your support! Star us on GitHub ⭐️

Star