SnackMagic

SnackMagic Automation management API

Automation related API endpoints

GitHub OpenAPI

Operations 2

POST /automations/orders Create automation order #
GET /automations/order_status Check order status #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/snackmagic/refs/heads/main/openapi/snackmagic-automation-management-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/snackmagic/refs/heads/main/errors/snackmagic-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/snackmagic/refs/heads/main/conventions/snackmagic-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/snackmagic/refs/heads/main/data-model/snackmagic-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/snackmagic/refs/heads/main/conformance/snackmagic-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/snackmagic/refs/heads/main/lifecycle/snackmagic-lifecycle.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/snackmagic/refs/heads/main/sandbox/snackmagic-sandbox.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/snackmagic-automation-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

snackmagic-automation-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '### *Stadium’s API can only be used by customers and partners on the Business and Enterprise Packages.'
  version: 2.0.0
  title: Stadium Automation management API
  termsOfService: https://www.bystadium.com/terms-of-use/
  contact:
    name: API Support
    email: engineering@bystadium.com
    url: https://www.bystadium.com
  x-logo:
    url: https://assets.auth0.bystadium.com/images/logos/color/stadium.svg
    altText: Stadium logo
servers:
- url: https://api.bystadium.com/api/v2
  description: Default server
- url: https://api.preprod.bystadium.com/api/v2
  description: Sandbox server
tags:
- name: Automation management
  description: Automation related API endpoints
paths:
  /automations/orders:
    post:
      tags:
      - Automation management
      summary: Create automation order
      description: 'Place order for webhook automation


        Each request will create a new order using the provided list of email addresses.


        You can check the status of your order using the identifier returned in the response.


        Please note that it may take up to 30 minutes to process the order.'
      operationId: createAutomationOrder
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createAutomationOrderResponse'
        '422':
          description: Error occurred while creating automation order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Automation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApiKey'
      parameters:
      - name: api_key
        in: header
        required: true
        schema:
          type: string
        description: 'API key of the webhook automation eg: `ryfMiGzMp8ZTisWYbZUhjkVL`'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contact_emails:
                  type: array
                  items:
                    type: string
                    format: email
                    description: Email of the recipient, e.g., `abc@example.com`
                recipient_message:
                  type: string
                  example: Happy Birthday!
                  description: This message is shown to the recipient at redemption. If no custom text is set, we will display the message configured during automation setup.
                sender_name:
                  type: string
                  example: John Doe
                  description: Name of the sender. If no name is provided, we will display the sender name configured during automation setup.
                budget:
                  type: number
                  example: 2500
                  description: Amount of points to be gifted. If no budget is provided, we will send the points budget configured during automation setup.
              required:
              - contact_emails
  /automations/order_status:
    get:
      tags:
      - Automation management
      summary: Check order status
      description: Check status for automation order
      operationId: checkOrderStatus
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckOrderStatusResponse'
        '422':
          description: Something went wrong, please try again later!
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderStatusApiErrorResponse'
        '404':
          description: Automation/Order not found.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InvalidApiKey'
                - $ref: '#/components/schemas/InvalidIdentifier'
      parameters:
      - name: api_key
        in: header
        required: true
        schema:
          type: string
        description: 'API key of the webhook automation eg: `ryfMiGzMp8ZTisWYbZUhjkVL`'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order_identifier:
                  type: string
                  description: 'Identifier of the order associated eg: `qmfMiGzMp8ZTiyuwZUhjyuis`'
              required:
              - order_identifier
components:
  schemas:
    createAutomationOrderResponse:
      type: object
      properties:
        identifier:
          type: String
          example: ryfMiGzMp8ZTisWYbZUhjkVL
          description: To identify the associated automation order
        data:
          type: array
          items:
            $ref: '#/components/schemas/createAutomationOrderDetail'
    OrderStatusDetail:
      type: object
      properties:
        email:
          type: string
          example: abc@example.com
          description: email of recipient
        status:
          type: string
          example: success
          description: 'status of order: success|pending|enqueued|failed'
        order:
          type: object
          properties:
            data:
              type: object
              properties:
                id:
                  type: integer
                type:
                  type: string
                attributes:
                  type: object
                  properties:
                    number:
                      type: string
                    total:
                      type: integer
                    shipment_status:
                      type: string
                    completed_at:
                      type: string
                      format: date-time
                    products:
                      type: array
    OrderStatusApiErrorResponse:
      type: object
      properties:
        errors:
          type: string
          description: Something went wrong, please try again later!
          example: Something went wrong, please try again later!
    InvalidApiKey:
      type: object
      properties:
        errors:
          type: string
          description: Automation with the given API key does not exist
          example: We are unable to find automation with the given API key
    CheckOrderStatusResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatusDetail'
    ApiErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              source:
                type: object
                properties:
                  pointer:
                    type: string
              detail:
                type: string
                description: Error Details
    createAutomationOrderDetail:
      type: object
      properties:
        email:
          type: string
          example: abc@example.com
          description: email of recipient
        status:
          type: string
          example: success
          description: 'status of order: success|pending|enqueued|failed'
        message:
          type: string
          example: Invalid email
    InvalidIdentifier:
      type: object
      properties:
        errors:
          type: string
          description: Automation with the given API key does not exist
          example: No order found for the given identifier
  securitySchemes:
    Token:
      type: http
      in: header
      scheme: bearer
      bearerFormat: JWT