Webhook Support

FileVerbs API supports webhooks to notify your application when a job is completed. You can specify a webhookUrl and optional webhookSecret headers in your job request.

Webhook Support (Optional)

You can optionally receive a webhook notification once the file conversion job is completed.

Field	Type	Required	Description
`webhookUrl`	`string`	No	An HTTPS URL that will receive a `POST` callback after successful job completion. Only HTTPS URLs are allowed.
`webhookSecret`	`Dictionary<string, string>`	No	Optional custom headers (e.g., `Authorization`) to be included in the webhook request. Useful for securing your endpoint.

Job Creation Request with webhook support:


"options": {
  "webhookUrl": "https://your-server.com/receive-webhook",
  "webhookSecret": {
    "Authorization": "Bearer 123456"
  }
}

Note:
• webhookUrl must begin with https://.
• webhookSecret is optional. If provided, these headers will be included in the webhook request.

Webhook Payload Example

When your webhook endpoint is called, it will receive a POST request with a JSON payload describing the job result.


{
  "jobId": "jobId",
  "status": "Completed",
  "outputs": [
    {
      "outputId": "outputId",
      "outputFormat": "docx",
      "outputSize": 107773,
      "fileName": "sample-document.docx",
      "contentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "createdDate": "2025-05-27T05:26:03.477Z"
    }
  ]
}

Tip: Your endpoint should return HTTP 200 OK to acknowledge receipt. If your endpoint is unavailable, FileVerbs may retry delivery.