Callback

When creating a new task, you can specify a callback call to your server. Whenever a task is done, whether it succeeds or not, PQScale will send a POST request to your designated target.

Callback Model

FieldTypeDescription

url

string

(optional) your designated callback url

data

string

(optional) your custom data which will be sent along side with the callback. (Maximum length: 4K)

Callback Request

The callback request will be sent to your url specified in the Callback Model. Your server should return a status code 200 to denote a successful callback. Other status codes will be considered failed and PQScale will attempt to send the callback again later.

Callback Request Model

FieldTypeDescription

id

string

Task ID

client_id

string

Client ID

status

string

The status of the task

data

string

The same value ofdata field in Callback Model

Last updated

Logo

Copyright © 2023 BTQ