When setting up data points in our system, you have the option to provide a callback URL. This URL should be fully qualified, meaning it must include the protocol (http:// or https://) and end with a trailing slash (/).
Example of a valid callback URL: https://example.com/callbacks/
Upon completion or modification of a job, our system will issue a POST request to the specified callback URL. The request will contain the job details in a JSON-formatted body.
Important Note on Delivery Guarantee:
Our system adheres to an "at least once" delivery guarantee for callbacks. This means that in certain scenarios, the same callback might be sent more than once. To accommodate this, your callback service should be idempotent. This ensures that receiving the same callback multiple times will not lead to duplicate processing or unintended side effects. It's crucial to design your service with this consideration in mind, enabling it to appropriately handle or disregard duplicate callback messages.
Callback Data Structure:
Below is an overview of the data structure you can expect to receive in the 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). |
This structure provides comprehensive details about the job's state and any relevant metadata, allowing your system to respond or update accordingly.