Skip to content

Example of Webhook Request

Request Mode

POST https://your-webhook

Headers

Content-Type: application/json
ComPDFKit-Signature: 8fef357511abec47a4a22313c1dcdb8b

Example Payload

Request parameters

ParameterData TypeDescription
eventNameStringCurrent event type
webhookTokenStringComPDFKit-Signature
sendTimeDateSending time
eventObjectStringTrigger object of the current event
java
{
    "eventName": "task.finish",
    "webhookToken": "225c4d7461bb91133a91251cece9cce2",
    "sendTime": Thu Dec 15 14:45:47 GMT+08:00 2022,
    "eventObject": "e74d60a6-fbd3-4d7d-9efa-0dc70297ee0b"
}

Note:

eventObject

  • If the current event type is a task object, the eventObject is a taskId
  • If the current event type is a file object, the eventObject is a fileKey