Webhooks

Starting with v3.0.0 we will be sending webhooks whenever a preflight is updated. The webhook body will look the same as the response you get from the GET /preflights/:id. As a reminder, here's what that looks like:

JSON

{
  "request_id": 21490,
  "created_at": "2024-08-05T08:50:31.913Z",
  "status": "completed",
  "name": "MyPreflight",
  "brand": "Acme",
  "market": "United Kingdom",
  "channel": "facebook_paid",
  "creatives": [
    {
      "post_id": 1234,
      "url": "https://s3.amazonaws.com/picassolabs-assets/original/file.mp4",
      "external_label": "Optional identifier",
      "scorecard_url": "http://www.creativex.com/audit/scorecards/1234?pretest=true",
      "scores": [
        {
          "name": "Creative Quality",
          "value": 0.8,
          "status": "status",
          "creative_quality_tier": "Excellent",
          "guidelines": [
            {
              "name": "Humanise",
              "weight": "20.0%",
              "passed": true
            },
            {
              "name": "Mention",
              "weight": "0.0%",
              "passed": true
            },
            {
              "name": "Branding: Brand Name",
              "weight": "20.0%",
              "passed": true
            },
            {
              "name": "Product",
              "weight": "20.0%",
              "passed": false
            },
            {
              "name": "Optimised for Sound Off",
              "weight": "20.0%",
              "passed": true
            },
            {
              "name": "Simple Message",
              "weight": "20.0%",
              "passed": true
            }
          ]
        }
      ]
    }
  ]
}

Webhook URLs are configured on the access token when it is issued. If you need to send webhooks to more than one URL, you'll need to get more access tokens. Contact [email protected] to get assistance in that process.