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": "88db42a7",
  "sku_id": "523a07fa",
  "sku_status": "Done",
  "sku_meta_data": {},
  "image_data": [
    {
      "image_id": "img-0f0d6707-d264-44fe-82ce-ab912b0a8ea0",
      "image_name": "3636_523a07fa_Exterior_1",
      "image_category": "Exterior",
      "frame_no": "1",
      "input_image": "https://spyne.s3.amazonaws.com/AI/raw/3636_523a07fa_Exterior_1.jpg",
      "output_image": "https://spyne.s3.amazonaws.com/AI/app/edited/car_replace_bg__9d76fe27-29a1-4778-a456-f8637047885e.png",
      "lowres_output": "https://spyne.s3.amazonaws.com/AI/raw/4c11fcd7-b67a-474c-a761-050049e8a000.jpg",
      "background_id": 3434,
      "status": "done",
      "image_meta_data": {}
    },
  ],
  "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9qZWN0X2lkIjoiODhkYjQyYTciLCJza3VfaWQiOiI1MjNhMDdmYSIsImlhdCI6MTY1NDU5OTYwMywiZXhwIjoxNjg1MzU4MDAzfQ.5P1SK7Thx6KhFkA9EsrD_tNCGCwWZE5CobOVvPALPjQ"
}

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"
      }
      ]
   }
image_idUID to identify the image
image_nameName of image
image_categoryIn the case of category_id being “Automobile” this parameter can be exterior, interior or misc as per the kind of image input, misc images will not be processed
sequenceNumberInteger identifying the sequence position of the image, indexed starting at 1
input_image_hres_urlHigh-resolution (1920x1080) URL of the input image
input_image_lres_urlLow-resolution (640x480) URL of the input image
output_image_hres_urlHigh-resolution (1920x1080) URL of the output image
output_image_lres_urlLow-resolution (640x480) URL of the input image
output_image_lres_wm_urlLow-resolution (640x480) watermarked URL of the input image
sourceSource of the input image could be App, API
created_onDate and time stamp of when the image output was created