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

Rate Limits

Rate limit headers are included in responses:

• X-RateLimit-Limit
• X-RateLimit-Remaining
• X-RateLimit-Reset

Table of contents

• Authentication
• Webhooks
• REST API