Sync/Async options
Webhook event
Webhook event that is send to the provided webhook.
id
string
Id of the job.
status
enum<string>
Status of the job.
signedUrlStatus
enum<string>
Status of the signed url.
NOT_PROVIDED
, nostorage.preSignedUrl
was provided.UPLOADED
,storage.preSignedUrl
was provided and file is uploaded.FAILED
,storage.preSignedUrl
was provided but the upload failed.
fileUrl
string
fileUrl
is only returned if the webhook was created with returnType
set to URL
and storage.signedUrl
is
is not used (unless signedUrlStatus
returns FAILED
)URL to the generated file. This url is valid for 1 hour, after that the file will be deleted from our storage.
fileBase64
string
fileBase64
is only returned if the webhook was created with returnType
set to base64
and
storage.signedUrl
is not used!The generated file base64 encoded (will be null if storage.signedUrl
is used).
metadata
object
The provided metadata when creating the job.
Was this page helpful?