База знаний

Вебхуки

Для доставки вебхуков используется метод
POST
. Данные отправляются в виде
JSON
. Для подтверждения доставки требуется вернуть код ответа
200
. При неудачной доставке будет совершенно несколько попыток доставить вебхук.
Пример формата:
{
"text": "🔥 Программист забыл точку с запятой.",
"meta": {
"title": "Incident caption",
"uuid":"cd5879b7-104e-4c20-ae84-39e4e26a6eb7",
"created_at":"2023-05-19T18:43:00+03:00",
"type": "incident_created",
"delivery_attempt":0,
"status_page":"0935e96c-34b6-46e8-82cb-def6d3d74d9c",
"payload":{
}
}
}
Доступные типы:
  • maintenance_created
    технические работы запланированы
  • maintenance_started
    технические работы начаты
  • maintenance_finished
    технические работы закончены
  • incident_created
    инцидент создан
  • incident_finished
    инцидент закончен
  • component_impact_updated
    состояние компонента изменено
Доступные варианты payload для типов
maintenance_created
,
maintenance_started
,
maintenance_finished
{
"text":"Maintenance name",
"meta": {
"title":"Maintenance name",
"uuid":"cd5879b7-104e-4c20-ae84-39e4e26a6eb7",
"text": "Message",
"end_at":"2023-05-19T18:43:00+03:00",
"start_at":"2023-05-19T17:43:00+03:00",
"type": "maintenance_created",
"affected_components":[
{
"impact":"under_maintenance",
"component_details":{
"name":"Component name",
"impact":"under_maintenance",
"component_uuid":"0935e96c-34b6-46e8-82cb-def6d3d74d9c"
}
}
]
}
}
для типов
incident_created
,
incident_finished
{
"text":"Incident title",
"meta": {
"uuid":"bd25a449-b655-49e3-ac46-a9d6ffd50691",
"title":"Incident title",
"end_at":null,
"type": "incident_created",
"start_at":"2023-05-19T17:05:00+03:00",
"affected_components":[
{
"impact":"degraded_performance",
"component_details":{
"name":"Component",
"impact":"degraded_performance",
"component_uuid":"88337a51-852b-48f3-ac8d-840e5f5326a0"
}
}
]
}
}
для типа
component_impact_updated
{
"text":"Component Name",
"meta": {
"title":"Component Name",
"uuid":"5f844cb4-32f8-43eb-aa3d-99c925d8fffe",
"type": "component_impact_updated",
"impact":"under_maintenance"
}
}