Skip to main content
OPTIONS
/
events
cURL
curl -i -X OPTIONS "https://api.box.com/2.0/events" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "chunk_size": 1,
  "entries": [
    {
      "type": "realtime_server",
      "url": "http://2.realtime.services.box.net/subscribe?channel=cc807c9c4869ffb1c81a&stream_type=all",
      "ttl": "10",
      "max_retries": "10",
      "retry_timeout": 610
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

Returns a paginated array of servers that can be used instead of the regular endpoints for long-polling events.

A list of real-time servers that can be used for long-polling.

​
chunk_size
integer<int64>

The number of items in this response.

Example:

1

​
entries
Real-time server · object[]

A list of real-time servers.