Webhooks (Coming Soon)

To provide a more efficient way to receive updates about your video processing jobs, AIFrame is planning to introduce support for webhooks.

Instead of repeatedly polling the /status/{video_id} endpoint, webhooks will allow your application to receive an HTTP POST request to a URL you specify as soon as a job's status changes (e.g., when processing completes or if it fails).

How it will work (Tentative)

Configuration: You will be able to configure a webhook endpoint URL in your AIFrame developer dashboard or potentially provide it during the initial video submission API call.
Events: We plan to send webhook notifications for key events such as:
- job.completed: When video processing finishes successfully.
- job.failed: When video processing encounters an error.
- Other events might be added based on demand.
Payload: The webhook request payload will contain information similar to the response from the /status/{video_id} endpoint, including the video_id, final status, download_url (if completed), or error_message (if failed).
Security: We will provide mechanisms to verify the authenticity of webhook requests, likely through a signing secret that you can use to validate the payload.

Benefits

Reduced Polling: Eliminates the need for constant polling, saving resources on both your end and ours.
Real-time Updates: Get notified immediately when a job is done.
Simpler Integration: Can simplify your application logic for handling asynchronous tasks.

Stay tuned for further announcements and detailed documentation once this feature is released.

We appreciate your interest and will update this section as soon as webhooks are available.