API Documentation

Webhook Responses

Once a screenshot has been successfully captured, we attempt to send a request to the webhook specified in the initial create request.

In the event of request failure, we attempt to make the webhook request a total of 5 times before giving up.

Delivery semantics

  • A 2xx response is treated as successful delivery.
  • Non-2xx responses or request timeouts are treated as failures.
  • Delivery attempts are 1 initial request + up to 4 retries.

Example Screenshot Webhook payload

The following is an example POST request with Content-Type: application/json sent to your webhook: 

{
  "data":{
    "screenshot":{
      "app": "outlook_mac",
      "mode": "dark",
      "status": "complete",
      "url": "https://preflight.qa/screenshot.png"
    }
  },
  "meta": {
    "guid": "abc123"
  }
}