Webhooks

Shipping Container Images On Premise also supports webhooks. It allows you to receive a HTTP POST request to a target URL of your choosing.

Go to Webhooks settings page to manage your webhooks or add a new webhook target.

Note:

• The Target URL should return a valid HTTP status code 200. If the Target URL consistently returns an error code, the hook will be removed and an email will be sent to the account owner.

• To quickly test out this feature, you can use webhook.site. It generates a unique target URL and displays all the requests made to that URL.

• A webhook is sent for each call to the recognition API even when no useful information is found.

Sample Response

{
  "hook": {
    "target": "https://webhook.site/6db201cf-ac3f-4cf7-8b63-2b10700bc2e1",
    "id": 1,
    "event": "image.done"
  },
  "data": {
    "results": [
      {
        "box": [
          0.16826382279396057,
          0.6135399341583252,
          0.24970881640911102,
          0.8984035849571228
        ],
        "score": 0.908203125,
        "label": "Serial Number",
        "rotation": 0,
        "texts": [
          {
            "value": "2179839",
            "score": 0.99951398
          }
        ],
        "height": 496,
        "width": 496
      },
      {
        "box": [
          0.2655954957008362,
          0.6176596283912659,
          0.3382174074649811,
          0.7459115386009216
        ],
        "score": 0.875,
        "label": "Size and Type Codes",
        "rotation": 0,
        "texts": [
          {
            "value": "22G1",
            "score": 0.99980831
          }
        ],
        "height": 496,
        "width": 496
      },
      {
        "box": [
          0.16080127656459808,
          0.4006018042564392,
          0.24229472875595093,
          0.5466212034225464
        ],
        "score": 0.85693359375,
        "label": "Owner Code and Category Identifier",
        "rotation": 0,
        "texts": [
          {
            "value": "TGHU",
            "score": 0.99999022
          }
        ],
        "height": 496,
        "width": 496
      }
    ],
    "original_width": 496,
    "original_height": 496,
    "processing_time": 144.538,
    "timestamp": "2024-10-15T07:58:03.692615Z",
    "camera_id": ""
  }
}