8.1.11.3. Query webhooks status

Prior to being notified by Core when webhooks mode is set, client can anytime ask Core for file / batch processing webhooks status

URL

  • File processing: /file/webhook/<data_id>

  • Batch processing: /file/webhook/<batch_id>

Method

GET

Header

Type

Required

Description

apikey

string

No

User's session id, if it was set for creation it is required

Result Code

Description

200

Webhooks status is fetched successfully

400

Bad request, (e.g.: wrong header values, invalid API key)

403

Access denied

404

Webhooks status is not found

callbackurl header wasn't added for the specified data_id

500

Internal server error

Successful response

HTTP status code: 200

{
"data_id": string,
"request_time": string,
"status_code": number,
"url": string
}

"status_code": indicates the status of callback sent from Core to designated remote server.

Successful

 

 

 

200

Callback was sent successfully

Failed

 

 

 

403

ContentAccessDenied
The access to the remote content was denied (similar to HTTP(S) error 401)

 

404

ContentNotFoundError
The remote content was not found at the server (similar to HTTP(S) error 404)

 

408

TimeoutError
The connection to the remote server timed out

 

503

HostNotFoundError
The remote host name was not found (invalid hostname)

 

520

RemoteHostClosedError
The remote server closed the connection prematurely, before the entire reply was received and processed

 

444

Other error types

Reference: https://doc.qt.io/archives/qt-4.8/qnetworkreply.html#NetworkError-enum

Enable debug log level on Core for further error description

Error response

Webhooks status not found

HTTP status code: 404

{
"err": "Webhook status not found."
}

Callback URL is not set

HTTP status code: 404

{
"err": "No callback url set."
}