Documentation

Events

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

Available webhook events

event name event description
task.start The task is created successfully. The current event will be triggered when each new task is created successfully
task.finish When 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.overdue The 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.start The current event is triggered when the file is uploaded successfully
file.success The file is processed successfully. The current event is triggered when the file is processed successfully
file.failed File processing failed. The current event is triggered when file processing fails