Indeed Real-time API events

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

 

After the user makes a GET request to the Indeed Real-time API endpoint and a message is sent in a conversation, the user receives server-sent events (SSE) that the backend service streams.

See Indeed Real-time API get started.

Conversation messages

When a new message is sent in a conversation, the user receives this event.

Clients are expected to maintain the state of conversations and refresh them accordingly. The IDs must match those that you get through the GraphQL API. Clients are encouraged to query and append only the latest messages by specifying after: in the GraphQL query rather than refreshing the entire conversation.

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

You can ignore or gracefully handle special events as part of connection maintenance.

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 realtime connection library has reliability and resiliency capabilities to gracefully recover from disconnections. The default configuration is passed as the realtime-connection-config event.

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

 

Was this page helpful?