Webhooks

Overview

It's often helpful to know when your deployment is complete, regardless of its state READY or ERROR. You can use a webhook with a deployment. Here's how it works:

We will make an HTTP POST request to the provided URL when your deployment is complete. 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.

The default timeout for the webhook is 10 seconds. If the webhook does not respond within this time, you will not receive any further notifications.

Deployment Webhook Example

POST request to /v1/deploy (API Reference)

Include your API Token in your Headers like this:

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

REST payload:

{
  "app_name": "speedtest",
  "version_name": "v1",
  "ip_list": ["1.1.1.1"],
  "webhook_url": "https://ptsv2.com/t/0n7by-1652897234/post"
}

Deployment Webhook Callflow

The following sequence diagram shows the call-flow of a Deployment webhook.