Webhook یک API بسیار کارآمد برای صاحبان وب سایت، مدیران سرور و شبکه و کارشناسان شبکه می باشد که مقادیر مشخص را در هنگام رخداد هر گونه هشدار به یک URL پست می کند. مقدار پست شده به نام webhook_data می باشد که یک آرایه به صورت json می باشد که شامل مقادیر زیر است.
results: will be true if this is a recovery alert and will be false if this is a down alert.
key: The key you enter below used to authenticate the hook request.
alert_date_time: The time the alert was sent.
downtime: The total downtime of this alert.
check_name: The name of the check.
hostname: The hostname/url of the check.
check_type: The type of check being performed.
check_notes: User entered check notes.
failure_message: User entered custom failure message, this is only sent on a failure.
recover_message: User entered custom recovery message, this is only sent on recovery.
first_down_time: When the first down alert was sent.
location: The location of the check failure, this is only sent on failure not on recovery.
error_message: The error message from the check, this is only sent on failure.
dns_hostname: The dns hostname being checked, only sent for the alert type of DNS.
dns_record_type: The record type of the DNS check, only sent for the alert type of DNS.
dns_server: The dns server being used to perform the check, only sent for the alert type of DNS.
برای ایجاد آن تنها کافیست به بخش API هشدار رفته و یک هشدار جدید ایجاد نمایید. سپس می بایست گزینه WebHook را انتخاب نمایید.
در بخش URL می بایست آدرس URL مدنظرتان که تمایل دارید اطلاعات به آن پست شود را وارد نمایید. برای ایجاد تفاوت بین Hook ها مختلف می توانید یک Key نیز برای آن تعریف نمایید که آن کلید نیز برای شما پست شود.
نکته: شما می بایست در قسمت لیست اطلاع رسانی این Hook را نیز فعال نمایید.
شما می توانید از کد نمونه زیر برای دریافت اطلاعات از طریق Hook استفاده نمایید:
<?php
$results = json_decode($_POST['webhook_data']);
if ($results->key == "mysecretkey") {
echo $results->downtime;
}
?>
