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

AI/Collab Processing Webhook Notification Doc

Webhook
POST
AI/Collab Processing Webhook Notification
AI/Collab Processing Webhook Notification
For requests submitted with processType: "ai" or processType: "collab", webhook notifications can be enabled by completing the integration with your callback URL. Once the integration is in place and image processing is completed, AutoBG will send a webhook notification to the callback URL provided by your team.
This webhook allows your system to receive real-time updates when a batch has finished processing and is ready for retrieval.
Webhook Trigger
The webhook is triggered immediately after the batch has been fully processed by AutoBG.
HTTP Method
POST
Example Payload
Payload Fields
status — Indicates whether the batch was processed successfully.
message — Human-readable description of the event.
data — Array containing processing details.
batchID — Unique identifier of the processed batch. Use this value to fetch the final processed images and related metadata through the API.
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.
Submit images using processType: "ai" or processType: "collab".
2.
AutoBG processes the uploaded images.
3.
AutoBG sends a webhook notification to your callback URL.
4.
Your system reads the batchID.
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 as soon as processing is complete.
Once the webhook notification is received, you can download the processed images 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": "Batch Processed",
  "data": [
    {
      "batchID": "1000024xxxx"
    }
  ]
}'
Response Response Example
{
  "success": true,
  "message": "Any Custom Message - Webhook notification received successfully. Batch download processing has been initiated."
}
Modified at 2026-07-06 13:00:38
Next
Reported Image Review Webhook Notification Doc
Built with