Skip to content

Introduction to BizzStream REST APIs

The BizzStream REST API allows you to programmatically manage resources, automate complex workflows, and sync data with external systems. Our API follows RESTful principles, ensuring predictable URLs and standard HTTP response codes.

Getting Started

To interact with the API, you can use any tool that supports HTTP. We primarily use cURL in our documentation examples due to its ubiquity in scripting and automation.

  • Tools: While we use cURL in our examples, tools like Postman or Insomnia are suitable for testing and exploring.
  • Support: Please note that BizzStream does not provide technical support for external tools like cURL or Postman.

Security & Authentication

All API requests require authentication to ensure data integrity.

  1. Bearer Tokens: Most endpoints require a valid Bearer token in the Authorization header.
  2. Environment ID: You must include your unique environment-id in the request headers.
  3. Network Access: We use a firewall to keep your data safe. Standard API calls shouldn't run into any roadblocks, but if you’re having trouble connecting, please contact our support team.

IMPORTANT: For detailed instructions on generating credentials, see our Authentication Guide.

Request Methods

BizzStream uses standard HTTP verbs to define actions:

Method Action Description
GET Read Retrieve data or a list of resources.
POST Create Create a new resource or trigger a specific action.
PUT Update or Replace Replace an existing resource with a new data set.
DELETE Remove Permanently delete a specific resource.

Response Handling

Success

A successful request will return a 2xx status code and a JSON body where the status field is set to "ok".

Error Responses

If a request fails, the API returns a structured JSON object to help you debug the issue quickly.

Example Error Object: 

{
  "status": "error",
  "error": "validation_error",
  "description": "Body error: \"value\" must be of type object",
  "message": "The data submitted is not in the expected format.",
  "userDescription": "Looks like there's an issue with the data you provided. Please double-check the input and try again."
  "validationErrors": []
}

Error Field Reference:

  • status: Always "error" for failed requests.
  • error: A machine-readable code (e.g., token_expired, not_found) for programmatic handling.
  • description: Technical details intended for the developer.
  • message: Often a slightly more generalized or concise version of the description, suitable for logging or initial developer alerts.
  • userDescription: A friendly, non-technical message that can be displayed directly to end-users.
  • validationErrors: An array of specific fields that failed validation (appears only on 400-level errors).