When creating jobs, you can supply a callback URL. This must be a fully qualified URL (i.e., includes http://
or https://
and the trailing /
).
Example callback URL: https://example.com/callbacks/
We will send a POST request to this URL when the job is completed or edited. The data will reach you as a JSON body. Below you can find the information contained within a callback.
Callback attributes
Attribute | Type | Description |
---|---|---|
id | string | Job identifier, corresponding to its identifier in the super.AI dashboard |
uuid | string | A universally unique identifier for the job |
state | string | Current status of the job: either FAILED , SUSPENDED , CANCELED , EXPIRED , or COMPLETED |
action | string | Whether the webhook was triggered by a job state change (RESOLVED ) or an edition (EDITED ). |