1. Operational Guidelines
Autobg
  • Operational Guidelines
    • AI/Collab Processing Webhook Notification Doc
    • Reported Image Review Webhook Notification Doc
  • Autobg Enterprise Api's
    • Create Template
      POST
    • List Templates
      POST
    • List Autobg Library
      GET
    • Upload/Process Images without Template.
      POST
    • Upload/Process Images with Template
      POST
    • Upload/Process Images with Template with Dynamic Branding
      POST
    • (Beta Mode) Upload/Process Images with Default Library Backdrop Templates
      POST
    • Upload/Process S3 Urls without Template.
      POST
    • Upload/Process S3 Urls with Template
      POST
    • Upload/Process S3 Urls with Template with Dynamic Branding
      POST
    • Report Images
      POST
    • Get Image Status
      POST
    • Download Processed Images
      POST
    • User Usage
      POST
    • User Credit Details
      POST
    • Get Raw Image in Base64 Format
      GET
    • Get Raw Image
      GET
  • Autobg Custom APIs
    • replaceNumPlate-v3
      POST
    • replaceNumPlateS3-v3
      POST
    • Send Images For QA
      POST
  1. Operational Guidelines

Reported Image Review Webhook Notification Doc

Webhook
POST
Reported Image Review Webhook Notification
Reported Image Review Webhook Notification
For reported images that are reviewed and reprocessed, webhook notifications can be enabled by completing the integration with your callback URL.
Once the integration is in place and the reported image has been reviewed and reprocessed by AutoBG, a webhook notification will be sent to the callback URL provided by your team. This webhook allows your system to receive real-time updates whenever an individual reported image has completed reprocessing and is ready for retrieval.
Webhook Trigger
The webhook is triggered immediately after a reported image has been reviewed by AutoBG.
HTTP Method
POST
1. Image Reviewed and Reprocessed
Sample payload sent:
1. Image Reviewed and Correction Out of Scope
Sample payload sent:
Payload Fields
status — Indicates whether the reported image was reviewed successfully.
message — Human-readable description of the event.
data — Array containing the reported image review details.
picId — Unique identifier of the reported image.
batchID — Unique identifier of the batch associated with the reported image.
reviewStatus — Indicates the outcome of the image review:
reprocessed — The reported image was reviewed and successfully reprocessed.
correction_out_of_scope — The reported correction was reviewed and determined to be out of scope.
Client Requirements
To receive webhook notifications, please provide a publicly accessible HTTPS endpoint that:
Accepts POST requests
Accepts JSON payloads
Returns a 200 OK response upon successful receipt
Recommended Workflow
1.
A reported image is submitted for review using the Report Images.
2.
AutoBG reviews the reported image.
3.
AutoBG sends a webhook notification to your callback URL with the review outcome.
4.
Your system reads the picId, batchID, and reviewStatus from the webhook payload.
5.
Your system retrieves the processed results using the download API endpoint.
This webhook-based workflow eliminates the need for continuous polling and ensures your system is notified immediately once the reprocessed image is ready.
Once the webhook notification is received, you can download the reprocessed image using the Download Processed Images API.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data '{
  "status": true,
  "message": "Reported image reviewed and reprocessed",
  "data": [
    {
      "picId": "67890",
      "batchID": "12345",
      "reviewStatus": "reprocessed"
    }
  ]
}'
Response Response Example
{
  "success": true,
  "message": "Any Custom Message - Webhook notification received successfully. Batch download processing has been initiated."
}
Modified at 2026-09-03 13:15:50
Previous
AI/Collab Processing Webhook Notification Doc
Next
Create Template
Built with