Webhooks

Automate status updates and announcements from external systems.

Update Status via Webhook

A simplified endpoint for updating component status without full admin access.

HTTP Method & URL: POST /api/WebHook/UpdateComponentStatus

Request

Headers

Name	Value	Required	Description
X-API-KEY	string	Yes	Your unique Webhook or API key.
Content-Type	application/json	Yes	Sending JSON data.

Payload

Body: JSON object

{
  "ComponentName": "API Service",
  "Status": "Major Outage"
}

cURL

curl -X POST "https://stg.itechops.com/api/WebHook/UpdateComponentStatus" \
     -H "X-API-KEY: your_webhook_key_here" \
     -H "Content-Type: application/json" \
     -d '{
           "ComponentName": "API Service",
           "Status": "Major Outage"
         }'

Responses

200 OK

Description: Success. Status updated via webhook.

{
  "Success": true,
  "Message": "Status updated via webhook"
}

400 Bad Request

Description: Invalid payload or component name.

{
  "Success": false,
  "Result": null,
  "Message": "Component not found."
}

401 Unauthorized

Description: Authentication failed.

{
  "Success": false,
  "Result": null,
  "Message": "Invalid or missing API key."
}

500 Server Error

Description: Internal server error.

{
  "Success": false,
  "Result": null,
  "Message": "An unexpected error occurred."
}