Indeed Real-time API events

The Indeed Real-time API streams server-sent events.

Overview

After you make a GET request to the Indeed Real-time API endpoint, the backend service streams server-sent events (SSE) to you. For example, you get an event when someone sends a message in a conversation.

Conversation messages

You receive this event when someone sends a new message in a conversation.

Your client should maintain the state of each conversation and refresh it as needed. The IDs must match the ones that you get through the GraphQL API. Instead of refreshing the whole conversation, query and append only the latest messages by specifying after: in the GraphQL query.

event:message-update
data:{
  "uuid": "369f9e4b-b33a-11ef-9fe5-ebeb7b06bb69",
  "eventType": "new-message",
  "payload": "{\"eventId\":\"56ccaa8c-3bea-4df5-92bc-c156ce9a853d\",\"conversationId\":\"AAAAAcExYNQnnBAuoDX5v6k489kdyhkX68nGVDlbdxPUT3cfBJom8n8rXzk-GcM51mPEjw==\"}",
  "eventTime": 1733424806682
}

Special events

Special events maintain the connection. You can ignore them or handle them gracefully.

Heartbeat

The heartbeat event indicates whether the connection is open and healthy.

event: heartbeat
data: 0

Connection metadata

The connection-metadata event provides a unique ID for the connection. You can safely ignore this event.

event: connection-metadata
data: {
  "connectionUuid": "9135df3f-3958-43ff-bc38-152731a28fa5"
}

Default recommended connection configuration

The real-time connection library recovers gracefully from disconnections. Its default configuration arrives in the realtime-connection-config event.

event: realtime-connection-config
data: {
  "retryConfig": {
    "waitMs": 3000,
    "maxWaitMs": 20000,
    "multiplier": 2.0,
    "maxAttempts": 5,
    "jitter": 0.2
  }
} 

On this page