Indeed Real-time API get started

Get started with the Indeed Real-time API.

 

Introduction

Use the Indeed Real-time API to stream real-time server-sent events (SSE).

When subscribed to the Indeed Real-time API, front-end applications can update in real-time by receiving server-sent events triggered by external sources. For example, the Indeed Real-time API enables a chat thread to instantly display new messages as other users send them. After a user makes a GET request to the endpoint, they subscribe to server-sent events (SSE) that the backend service streams.

When a new message is sent in a chat, an event is published. Front-end applications subscribed to the Indeed Real-time API then receive this event and can update the thread to display the new message.

This event can be heartbeat, connection-metadata, realtime-connection-config, and message-update. See Indeed Real-time API events.

Onboard to Indeed Real-time API

To use Indeed Real-time API endpoints, Indeed PLUS developers must add the domain of their application as a trusted domain in our service.

Authorization code grant type (3-legged OAuth) steps

Requests from non-indeed domains must use the Authorization code grant type (3-legged OAuth).

Request

To subscribe to any server-sent events (SSE) that the backend service streams, the caller makes a GET request to the Indeed Real-time API endpoint. The GET request must include the access token in the Authorization header with the Bearer authentication scheme.

To filter the response by event types, specify a comma-separated list of event types in the eventTypes query parameter. By default, the API streams all events.

Response

The response code in the response object indicates success or failure of the operation:

Real-time API response codes

Response code		Description
200	Success	A successful response includes these fields: Field Type Description uuid uuid Unique ID for deduplication. This UUID contains an encoded timestamp that measures end-to-end latency. eventType string Client-specified event type to filter events. payload string Optional. Client-specified JSON object, serialized as a string, with additional information about the event. eventTime int64 Timestamp when the event occurred, in milliseconds since epoch. Default is the time when the event was triggered.
400	Error	An error occurred due to incorrect authentication. See Troubleshoot OAuth errors.

 

Was this page helpful?