Indeed Real-time API get started
Get started with the Indeed Real-time API.
Overview
#Use the Indeed Real-time API to stream server-sent events (SSE) to your front-end application, so it can update in real time.
For example, when someone sends a chat message, Indeed publishes an event. Your application receives the event and can show the new message in the thread right away.
The event types are connection-metadata, heartbeat, message-update, new-message, and realtime-connection-config. For details, see Indeed Real-time API events.
API steps
#1. Set up the Indeed Real-time API
#Before you call the Indeed Real-time API, ask your Indeed representative to add your application's domain as a trusted domain.
2. Authenticate
#To authenticate requests from non-Indeed domains, use the Authorization code grant type (3-legged OAuth).
3. Subscribe to server-sent events
#To subscribe, send a GET request to the Indeed Real-time API endpoint. Pass the access token in the Authorization header with the Bearer scheme.
The API streams all event types by default. To get only some, pass a comma-separated list of event types in the eventTypes query parameter.
The response code shows whether the request succeeded:
| Response code | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 | Success | A successful response includes these fields:
| |||||||||||||||
401 | Error | Authentication is incorrect. See Troubleshoot OAuth errors. | |||||||||||||||
See also
#Guides
#- Authorization code grant type (3-legged OAuth) — Authorize your app to act on behalf of Indeed user accounts and associated employer accounts.
- Indeed Real-time API events — Lists the events that the Indeed Real-time API streams.
- Troubleshoot OAuth errors — Explains how to fix OAuth errors that occur before you access Indeed APIs.
REST API reference
#- Stream real-time updates — Streams server-sent events to subscribed applications.