HTTP API

The Push To Display API has one public endpoint: POST /v1/updates. That's all you need to send content to any board.

Base URL

https://api.pushtodisplay.com

Authentication

Include your API key in the X-Api-Key header on every request. See Authentication for how to get a key.

X-Api-Key: pt_your_api_key_here

Content type

All requests must include Content-Type: application/json.

Quick example

curl -X POST https://api.pushtodisplay.com/v1/updates \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <your-api-key>" \
  -d '{"boardId":"<board-id>","blocks":[{"text":"Hello!"}]}'

When to use the API

The HTTP API is the right choice when you're:

Integrating from a backend service, script, or webhook
Working in a language that doesn't have a dedicated SDK
Building a custom automation that needs to push updates programmatically

If you're working from a terminal, the CLI wraps this endpoint with a friendlier interface. For CI/CD pipelines, the GitHub Action handles the HTTP call for you.

See the full POST /v1/updates reference for all request fields, response formats, and error codes.