DocsWebhook

    🔗 Webhook

    Bluente uses webhooks to notify you when the translation status changes to READY or ERROR. You can set up webhooks in the Bluente Dashboard.


    Example of Bluente Dashboard

    Example: Bluente Dashboard has webhook settings.


    ✅ Request Body

    {
      "engine": 3,
      "filename": "xxxxxxx.pdf",
      "meta_data": {
        "job_id": "...",
        "session_id": "...",
        "region": "ca"
      },
      "page_count": 2,
      "source_language": "en",
      "state": "READY",
      "target_language": "zh",
      "task_id": 1,
      "created_at": "2025-10-08 11:32:59",
      "updated_at": "2025-10-08 11:36:03",
      "user_id": "xxxx"
    }

    📊 Response Fields

    FieldTypeDescription
    engineintEngine ID
    filenamestringFilename
    meta_datajsonMetadata for the translation task. If set in translate API, it will be returned here.
    page_countintNumber of pages in the uploaded document
    source_languagestringSource language code
    statestringCurrent processing status (see state list below)
    target_languagestringTarget language code
    task_idintTask ID
    created_atstringCreated timestamp
    updated_atstringLast updated timestamp
    user_idstringUser ID

    📌 State Values

    StateDescription
    READYTranslation completed. (At this point, call Download File API)
    ERRORSomething went wrong. Stop checking and show an error message.