Skip to main content
The BuildPixel API is JSON-over-HTTPS REST, with a Socket.IO channel for live build logs and outbound webhooks for event delivery.

Base URL

Quick example

For real-time monitoring, prefer Socket.IO over polling.

Conventions

IDs

Resource IDs are 24-char strings. URL-safe, sortable by creation time, globally unique within an org.

Timestamps

ISO 8601, UTC:

Pagination

List endpoints use cursor-based pagination:
limit defaults to 25, max 100. The cursor is opaque — don’t try to parse it.

Where to go next

Authentication

How to get a token and use it.

Errors

Status codes and the error response shape.

Builds

Trigger, list, fetch, download artifacts.

Real-time

Socket.IO for live build status and logs.