Webhook Events and Management

Overview

Webhooks are a powerful feature that allows your application to receive real-time notifications about events occurring within the iQ Suite Platform. By setting up webhooks, you can handle asynchronous operations efficiently without the need for continuous polling, thereby enhancing the responsiveness and scalability of your application.

Webhook Events

Description

Webhooks enable your application to receive real-time notifications about various events such as index creation completion, document addition status, and more. These notifications are sent as HTTP POST requests to your specified endpoint, allowing your application to respond promptly to changes and updates.

Event Payload Structure

A typical webhook payload sent by the iQ Suite Platform looks like this:

{
  "event": "index_creation_complete",
  "task_id": "2dca8de9-8a51-497a-9a45-cc6541d4a7bc",
  "index_id": "08c9ab9f-1b1c-4fc8-8679-a63387654893",
  "status": "completed"
}