Skip to content

Webhook

Events

ComPDFKit API can notify your application about the status of tasks. You can create and manage your webhooks on the ComPDFKit API dashboard.

As shown in the following figure:

image-20230505174744854

Available Webhook Events

EventEvent Description
task.startThe task is created successfully. The current event will be triggered when each new task is created successfully
task.finishWhen the task processing is completed, all files under the task are processed, triggering the current event (regardless of whether the file processing is successful or not)
task.overdueThe task waiting for processing has timed out. The task has not been executed since it was created. The current event is triggered when a certain threshold (one hour) is reached
file.startThe current event is triggered when the file is uploaded successfully
file.successThe file is processed successfully. The current event is triggered when the file is processed successfully
file.failedFile processing failed. The current event is triggered when file processing fails