Skip to main content

Webhook

Overview#

It's often helpful to know when your deployment is complete no matter its state (READY or ERROR). You can use a webhook with a deployment. Here's how it works.

Arbitrium will make an HTTP POST request at the provided URL when you complete a deployment. This request contains a JSON body with the same data provided by our route /v1/status/{request_id}. We expect no response from your side.

Example#

Make a POST request at this endpoint

Include your API Token in your Headers like this:

{
"Content-Type": "application/json",
"Authorization": "token super_secret_token_1234"
}

REST payload example:

{
"app_name": "speedtest",
"version_name": "v1",
"ip_list": ["1.1.1.1"],
"webhook_url": "https://www.myserver.com"
}