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
}

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."
}