API Reference

ButterStack provides APIs for integrating with your build pipeline and custom tooling.

API Types

Webhooks (Inbound)

Receive events from your tools (Perforce, Jenkins, etc.) via webhook endpoints.

Webhooks Documentation

REST API (Outbound)

Query and control ButterStack programmatically.

REST API Documentation

Authentication

All API endpoints require authentication:

• Webhooks: Token-based (?token=YOUR_TOKEN)
• REST API: Bearer token in Authorization header

Authentication Guide

Base URL

The JSON API is served from the app host under /api/v1 - there is no separate api. subdomain:

https://www.butterstack.com/api/v1

Rate Limits

Inbound webhook endpoints have no dedicated throttle beyond the per-IP limit.

A throttled request returns 429 with a Retry-After header. No X-RateLimit-* headers are emitted.

Table of contents

• Authentication
• Webhooks
• REST API
• Workspace Events