DocKing - ShipSaaS
Docking GitHub
  • DocKing from ShipSaaS
  • Architecture
  • Requirements
  • PDF Engines
    • Gotenberg
    • WkHTMLtoPDF
    • mPDF
  • Upgrade Notes
    • v1.4.0
    • v1.3.2
    • v1.3.1
    • v1.3.0
    • v1.2.0
    • v1.1.2
    • v1.1.1
    • v1.1.0
  • Usage
    • Basic
    • Endpoints
    • Webhook
    • Maintain IDs/Keys from Services
  • Getting Started
    • Environment Variables
    • Run on Local
      • Normal Run
      • Docker
    • Storage
    • Console UI
    • Document Template
      • Gotenberg's Metadata
      • wkHTMLtoPDF's metadata
      • mPDF's metadata
    • Templating Mode
    • Fonts
    • Octane / High-perf mode
    • Localization
  • Deployment
    • Linux VPS / Dedicated Server
    • Docker
Powered by GitBook
On this page
  • Method
  • Payload's Structure
  • Notes
  1. Usage

Webhook

Webhook notification on rendered successfully

Only available for "async" render mode.

For Async Render mode, we provide a simple webhook notification to your desired endpoint.

With this, you can know when your PDF file is rendered or not.

Method

POST

Payload's Structure

{
    "file": {
        "uuid": "fileUuid",
        "url": "fileUrl",
        "path": "..",
        "size": "..",
        "created_at": ".."s
    }
}

Notes

If you use an External URL (eg your app domain), you need to ensure the DocKing instance can make outbound internet requests.

It won't retry if your endpoint does not return 200 status code.

PreviousEndpointsNextMaintain IDs/Keys from Services

Last updated 1 year ago