Integration Points
Create Session Hook

🚀 Create Session Hook

Trigger Event: Initiated when a new session is created.

Purpose: Allows partners to track the initiation of new sessions and can be used for logging, monitoring, or initiating preliminary processes that are necessary for a new session.

Usage Requirements:

  • 🟡 Optional but Encouraged: While implementation of this hook is optional, we strongly encourage all partners to implement it. It provides valuable real-time insights into session creation and enables automated workflows that can significantly enhance operational efficiency and resource allocation.

Usage Example: Partners may use this hook to allocate resources or trigger specific workflows tailored to the needs of each session.

Example Response:

{
  "success": true,
  "processed": true
}

Response Fields:

  • success: A boolean flag indicating whether the hook was successfully received and processed (true) or encountered an error (false).
  • processed: A boolean flag indicating whether the partner's system has successfully processed the session creation notification (true) or not (false).