Webhooks are HTTP callbacks that contains image data for SKUs.

This is a push notification service to notify you every time a SKU gets completed. You can subscribe to the push service on a particular URL (e.g. https://test.com/subscription) which will receive a payload. You would need to provide the subscription URL to your Spyne POC. Image data will be provided in a sequence as per the SKU.

Sample Payload v2.0

📘

This is the updated webhook which has the same response structure as the Get Ready Images API.

{
  "project_id": "79c541576d964ec8931e2640e6236aee",
  "sku_status": "Done",
  "sku_id": "c979b312828a4bfdb680a43daf25ad62",
  "sku_meta_data": {},
  "sku_name": "12345678136373839",
  "user_id": "6a9cff86",
  "total_frame_count": 1,
  "image_data": [
    {
      "image_id": "img-e9294c35-b5d4-43a0-8036-15203a489add",
      "image_name": "12345678136373839_c979b312828a4bfdb680a43daf25ad62",
      "angle": 180,
      "image_category": "Exterior",
      "frame_no": "1",
      "lowres_output": "https://spyne-media.s3.amazonaws.com/2024-10-10/5ee009be-6657-46a8-8e3b-95e4f348fe60.jpg",
      "background_id": "66632",
      "status": "Done",
      "image_meta_data": {},
      "reject_reason": null,
      "input_image": "https://spyne-prod-tech.s3.amazonaws.com/49fba62ae/6a9cff86/79c541576d964ec8931e2640e6236aee/c979b312828a4bfdb680a43daf25ad62/images/input/hres_12345678136373839_c979b312828a4bfdb680a43daf25ad62_Exterior_2.jpg",
      "output_image": "https://spyne-media.s3.amazonaws.com/2024-10-10/car_replace_bg_ccc2226b-29d8-48eb-9b86-2b98c7e42ec5.png"
    }
  ],
  "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9qZWN0X2lkIjoiNzljNTQxNTc2ZDk2NGVjODkzMWUyNjQwZTYyMzZhZWUiLCJza3VfaWQiOiJjOTc5YjMxMjgyOGE0YmZkYjY4MGE0M2RhZjI1YWQ2MiIsImlhdCI6MTc0MTE3ODY4NSwiZXhwIjoxNzcxOTM3MDg1fQ.8NJMH_huBR9t55t-1gX1Vok9diGd2qHvT83cspX1qoM",
  "VIN": "12345678136373839",
  "team_name": "Team 1",
  "source": "App_android"
}

Sample Payload v1.0 (deprecated)

This payload response is no longer in use, kindly switch to v2.0 above.

{
   "project_id":"sample_project_id_123",
   "sku_id":"sample_sku_id_123",
   "image_data":[
      {
         "image_id":"img-cfd049e5-c129-4592-a31f-efd46e5ae938",
         "image_name":"QNM9873_82a15664_ext_1",
         "image_category":"Exterior",
         "sequenceNumber":"1",
         "input_image_hres_url":"https://storage.googleapis.com/spyne/AI/raw/QNM9873_82a15664_ext_1.jpg",
         "input_image_lres_url":"https://storage.googleapis.com/spyne/AI/raw/efc41c27-a1dc-4ba8-9dd7-95ca311fac5a.jpg",
         "output_image_hres_url":"https://storage.googleapis.com/spyne/AI/app/edited/car_replace_bg__f929a973-6d6a-4b22-a5a0-612020de6819.png",
         "output_image_lres_url":"https://storage.googleapis.com/spyne/AI/raw/e7b51a39-29a4-4ffe-918a-a44ea12388f7.jpg",
         "output_image_lres_wm_url":"https://storage.googleapis.com/spyne/AI/raw/f9817bd3-ea9e-4f0e-99e1-caf96f64a943.jpg",
         "source":"App",
         "created_on":"2021-09-14T09:48:08.000Z"
      },
      {
         "image_id":"img-b2db25ed-9947-48ae-a3e1-997ea636824e",
         "image_name":"QNM9873_82a15664_ext_2",
         "image_category":"Exterior",
         "sequenceNumber":"2",
         "input_image_hres_url":"https://storage.googleapis.com/spyne/AI/raw/QNM9873_82a15664_ext_2.jpg",
         "input_image_lres_url":"https://storage.googleapis.com/spyne/AI/raw/d533a9af-28a2-417d-bba9-93f4f6a56c70.jpg",
         "output_image_hres_url":"https://storage.googleapis.com/spyne/AI/app/edited/car_replace_bg__2435c80a-20de-4260-94e4-ae35ff687e2f.png",
         "output_image_lres_url":"https://storage.googleapis.com/spyne/AI/raw/f6f96205-0b3d-4146-acee-3f340ec3d36d.jpg",
         "output_image_lres_wm_url":"https://storage.googleapis.com/spyne/AI/raw/bf0b6a3c-7166-4c84-aa76-c1b6f2272803.jpg",
         "source":"App",
         "created_on":"2021-09-14T09:49:26.000Z"
      }
      ]
   }