Documentation Hub

Webhooks

Webhooks are like our API but unlike our API where you'll have to make requests to Qloaked with a webhook Qloaked will notify your application when a new domain is being created in your account. You'll need an endpoint URL to send the requests to, for example:

https://api.yoursaas.com/hooks/domain

Then when a new domain comes in we will send a JSON payload to that specified endpoint.

{
  "action": "created",
  "domainName": "example.clientdomain.com",
  "applicationName": "Production App",
}

By default, even if there's no response from your server or your server is down for whatever reason, we will provision the SSL certificate and setup the domain for your account. However if it's a domain you don't want Qlaoked to support you can respond with two different status codes:

405/406 (Not Acceptable) - We disable (block) the domain

Qloaked will then update the domain based on that response status code from your application. We went for something less standard than 404, 401 etc... so that you don't accidentally interrupt the service when you don't mean to.

Let us know if you have any questions or need any help getting setup.