Preflight Webhooks

This is an enterprise feature. Please reach out to us if you want to get access.
Preflight webhooks are triggered by Steadybit whenever an experiment is about to start and allow you to prevent an execution. For deciding whether that specific experiment run is allowed to start you get a list of all expected to be affected targets in the webhook call. However, due to concurrency, these set of targets may change in case one of the targets is gone when the actual step starts.
You can configure preflight webhooks at Settings / Application Settings / Integrations / Preflight webhook. The content type of the body is application/json and the message is described in our OpenAPI specification as WebhookPayload. If the webhook returns a HTTP status code other than 2xx, the experiment will not be started.
addPreflightWebhook.png
Name
The name for this preflight webhook will not show up in the JSON body.
URL
The URL, which will receive a HTTP Post request with the JSON body
Secret
You may a specify a secret which will be used to sign the body. Verifying the signature.
optional
Team
If no team is specified, preflight checks will be performed for all teams. If you do specify a team only preflight checks are made for this team. Other teams are not involved in this check.
Events
There is only one event here. The event: Execution preflight checks
Verifying the Signature
If a secret is provided a signature of the body is computed using HMAC SHA-256 and sent as X-SB-Signature http header. You can use this header to verify the message.
Here is an example of doing this in Java:
private static boolean validateSignature(byte[] body, String secret, String header) throws Exception {
    //calculate the signature using the secret
    Mac mac = Mac.getInstance("HmacSHA256");
    mac.init(new SecretKeySpec(secret.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
    byte[] signature = mac.doFinal(body);
​
    //remove the algorithm prefix and decode the hex to bytes[]
    byte[] receivedSignature = Hex.decode(header.replaceFirst("^hmac-sha256 ", ""));
​
    //compare using time-constant algorithm
    return MessageDigest.isEqual(signature, receivedSignature);
}
Run Status
During the experiment run you can see that preflight webhooks are triggered
prefligtRunStatusSuccess.png
prefligtRunStatusFail.png

Last modified 4d ago

Name	The name for this preflight webhook will not show up in the JSON body.
URL	The URL, which will receive a HTTP Post request with the JSON body
Secret	You may a specify a secret which will be used to sign the body. Verifying the signature. optional
Team	If no team is specified, preflight checks will be performed for all teams. If you do specify a team only preflight checks are made for this team. Other teams are not involved in this check.
Events	There is only one event here. The event: Execution preflight checks