Webhooks
Webhooks provide real-time programmatic event notifications for your monitoring services, billing, and account status. For detailed information about webhook schema's and formatting, see the Webhooks section of the API documentation.
Webhooks are triggered using application/json POSTs to your endpoint.
This section covers:
- Adding a Webhook: create a webhook and send a test event.
- Delivery, Retries, and Failure Handling: how deliveries are retried, backed off, and disabled.
- Verifying Webhook Signatures: confirm that requests came from our platform.
Events
Each webhook can be configured to receive one or more Events from our platform, currently available in the following categories:
-
Billing Events: provides billing related event data, including payment alerts, renewal notices, and more.
billing.balance.alert: Triggered when your account balance goes below your alert threshold.billing.recharge.success: Triggered when an auto-recharge is successful.billing.recharge.failed: Triggered when an auto-recharge attempt fails.billing.renewal.success: Triggered when your billing package is successfully renewed.billing.renewal.failed: Triggered when a package renewal attempt fails.expiring.card.alert: Triggered when one of your credit cards is about to expire.expiring.plan.alert: Triggered when your monthly plan is set to expire and auto-renewal is disabled.
-
RBL Monitoring Events: provides real-time RBL monitoring event data, related to hosts being monitored on your account.
rbl.host.check.started: Triggered when a check is started for one of your hosts.rbl.host.check.completed: Triggered when a check completes for one of your hosts.rbl.host.listed: Triggered when one of your hosts becomes listed.rbl.host.delisted: Triggered when one of your hosts becomes delisted.
-
Certificate Monitoring Events: provides real-time certificate monitoring event data, related to monitors configured on your account.
cert.expiration.trigger: Triggered when a certificate expiration threshold is crossed.cert.expiration.resolve: Triggered when an expiring certificate is renewed.cert.error.trigger: Triggered when new certificate errors are detected.cert.error.resolve: Triggered when previously detected certificate errors are resolved.cert.changed: Triggered when a certificate changes without a renewal.cert.flapping: Triggered once when three or more certificate fingerprint changes are detected within a one-hour window. This typically indicates that CDN or load-balancer nodes are serving different certificates. The payload includesflap_count,stable_fingerprint, andalt_fingerprint.cert.flapping.resolve: Triggered once when the certificate fingerprint has been stable for a full hour after a flapping episode. The payload includesstable_fingerprint.
-
Agent Events: provides real-time event data related to monitoring agents configured on your account.
agent.timeout: Triggered when a persistent monitoring agent instance stops checking in and exceeds its configured timeout threshold. The payload includes the agent name and SID, the instance identifier and IP addresses, the last check-in timestamp, and the configured timeout in minutes.agent.timeout.resolve: Triggered when a monitoring agent instance that had timed out resumes checking in. The payload includes the agent name and SID, and the instance identifier and IP addresses.