Callbacks, also known as webhooks, are user-defined HTTP callbacks that allow real-time notifications of events happening within a system. In the context of superAI, webhooks enable users to receive updates about the status of their jobs, such as when a job is completed. Instead of constantly polling the superAI API to check the job status, users can provide a callback URL, which superAI will send a POST request to once the job or batch is done.

This is useful for integrating with external systems or triggering automated workflows whenever specific events are performed in the platform.

Supported callback entity types:

Callbacks can be enabled in the project settings: Project Wide Callbacks on a global project basis or specifically set for each job submission: Job Callbacks.

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.

Security

Visit our Secure Callbacks page to learn how to enable security features for callbacks.