Skip to content

Streams API reference

View Markdown

Insights events live in streams. Every project has two built-in streams: default, which receives events sent by your applications, and internal, which receives Honeybadger-generated events such as error occurrences, deployments, uptime checks, and check-ins.

Use stream IDs in the stream_ids request field to choose which streams Insights queries and alarms search.

Terminal window
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/streams

Returns a list of the project’s streams.

{
"results": [
{
"id": "a1b2c3d4e5f6",
"name": "Default",
"slug": "default",
"internal": false,
"project_id": 1,
"created_at": "2026-07-15T13:56:29.513358Z"
},
{
"id": "f6e5d4c3b2a1",
"name": "Internal",
"slug": "internal",
"internal": true,
"project_id": 1,
"created_at": "2026-07-15T13:56:29.513358Z"
}
],
"links": {
"self": "https://app.honeybadger.io/v2/projects/1/streams"
}
}
Field nameTypeDescription
idstringThe stream ID accepted by the stream_ids request field in Insights queries and alarms.
namestringThe stream’s display name.
slugstringThe stable identifier for the stream’s role: default or internal.
internalbooleanWhether the stream holds Honeybadger-generated events (notice, deploy, uptime_check, and so on).
project_idintegerThe project the stream belongs to.
created_atstringThe ISO 8601 timestamp when the stream was created.

Streams also appear in the streams array of project payloads.

  • Stream selection is per-project. IDs that don’t belong to the project (whether unknown or from another project) are silently ignored. A request containing those IDs may therefore return fewer results than expected instead of an error.
  • Streams are provisioned asynchronously after project creation, so a just-created project’s stream list may be empty or partial for a short time. Retry the request before concluding that streams are missing.