Appmixer Messages API

Unprocessed message management

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

appmixer-messages-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Appmixer Accounts Messages API
  description: The Appmixer REST API provides programmatic access to manage workflows, users, accounts, apps/connectors, files, data stores, insights, and people tasks within the Appmixer embedded iPaaS platform. The API allows you to access all the features that the Appmixer UI works with.
  version: 6.1.0
  contact:
    name: Appmixer
    url: https://www.appmixer.com/
  license:
    name: Proprietary
    url: https://www.appmixer.com/terms-and-conditions
servers:
- url: https://api.{tenant}.appmixer.cloud
  description: Appmixer Cloud Tenant API
  variables:
    tenant:
      default: YOUR_TENANT
      description: Your Appmixer tenant identifier
security:
- bearerAuth: []
tags:
- name: Messages
  description: Unprocessed message management
paths:
  /unprocessed-messages:
    get:
      operationId: listUnprocessedMessages
      summary: Appmixer List unprocessed messages
      description: Get the list of unprocessed messages.
      responses:
        '200':
          description: Unprocessed messages returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UnprocessedMessage'
        '401':
          description: Unauthorized
      tags:
      - Messages
  /unprocessed-messages/{messageId}:
    post:
      operationId: reprocessMessage
      summary: Appmixer Reprocess a message
      description: Put an unprocessed message back into the Appmixer engine.
      parameters:
      - name: messageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Message reprocessed successfully
        '401':
          description: Unauthorized
        '404':
          description: Message not found
      tags:
      - Messages
    delete:
      operationId: deleteUnprocessedMessage
      summary: Appmixer Delete an unprocessed message
      description: Delete a specific unprocessed message.
      parameters:
      - name: messageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Message deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Message not found
      tags:
      - Messages
components:
  schemas:
    UnprocessedMessage:
      type: object
      properties:
        messageId:
          type: string
        flowId:
          type: string
        componentId:
          type: string
        data:
          type: object
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Access token obtained from the /user/auth endpoint. Pass as Authorization: Bearer {token} header.'