Inngest Apps API

openapi: 3.2.0
info:
  description: The v2 API delivers a significantly improved developer experience with consistent design patterns and enhanced functionality.
  title: Inngest REST API v2 Apps API
  version: 2.0.0
servers:
- description: Production server
  url: https://api.inngest.com/v2
- description: Development server
  url: http://localhost:8288/api/v2
tags:
- description: Sync and manage
  name: Apps
paths:
  /apps:
    get:
      description: Lists active apps in the authenticated environment. Set archived to true to list archived apps instead.
      operationId: V2_GetApps
      parameters:
      - description: Pagination cursor from previous response
        in: query
        name: cursor
        schema:
          type: string
      - description: 'Number of apps to return per page (min: 1, max: 100)'
        in: query
        name: limit
        schema:
          default: '20'
          format: int32
          type: integer
      - description: Whether to return archived apps instead of active apps
        in: query
        name: archived
        schema:
          default: 'false'
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2GetAppsResponse'
          description: A successful response.
      security:
      - BearerAuth: []
      summary: Get apps
      tags:
      - Apps
      x-beta: true
  /apps/{appId}:
    get:
      description: Fetches details for a single app, including sync metadata and function count
      operationId: V2_GetApp
      parameters:
      - description: The user-defined app ID
        in: path
        name: appId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                default:
                  value:
                    data:
                      createdAt: '2024-01-10T09:15:00Z'
                      functionCount: 2
                      id: my-app
                      isArchived: false
                      latestSync:
                        sdkLanguage: typescript
                        sdkVersion: 3.22.0
                        url: https://example.com/api/inngest
                      method: SERVE
                      name: my-app
                    metadata:
                      cachedUntil: null
                      fetchedAt: '2024-01-20T14:22:33Z'
              schema:
                $ref: '#/components/schemas/v2GetAppResponse'
          description: A successful response.
      security:
      - BearerAuth: []
      summary: Get app
      tags:
      - Apps
      x-beta: true
  /apps/{appId}/syncs:
    post:
      description: Sync an app at the provided URL.
      operationId: V2_SyncApp
      parameters:
      - description: App ID
        in: path
        name: appId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2SyncAppBody'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2SyncAppResponse'
          description: App sync completed successfully or the app was already up to date
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Bad Request - invalid input data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Unauthorized - authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Forbidden - insufficient permissions
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Not Found - environment not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2SyncAppResponse'
          description: Unprocessable Entity - sync failed. The response body is still SyncAppResponse and includes the persisted deploy plus a coded error under data.latestSync.error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Internal Server Error
      security:
      - BearerAuth: []
      summary: Sync app
      tags:
      - Apps
      x-beta: true
components:
  schemas:
    v2SyncAppError:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    v2SyncAppData:
      properties:
        appId:
          description: App ID
          type: string
        error:
          $ref: '#/components/schemas/v2SyncAppError'
        id:
          description: ID
          type: string
        status:
          description: Status of the sync. `success` and `duplicate` are successful terminal states. `duplicate` means the sync payload matched the previous successful sync, so no function configuration changes were applied. `error` is a failed terminal state, and `pending` means the sync is still in progress.
          enum:
          - pending
          - success
          - error
          - duplicate
          type: string
      type: object
    v2App:
      properties:
        appVersion:
          description: User-defined app version, if set
          type: string
        archivedAt:
          description: Timestamp when the app was archived (if archived)
          format: date-time
          type: string
        createdAt:
          description: Timestamp when the app was first synced
          format: date-time
          type: string
        functionCount:
          description: Number of functions in the app
          format: int32
          type: integer
        id:
          description: The user-defined app ID
          example: my-app
          type: string
        isArchived:
          description: Whether the app is archived
          type: boolean
        latestSync:
          $ref: '#/components/schemas/v2AppSync'
        method:
          $ref: '#/components/schemas/v2AppMethod'
        name:
          description: App name
          example: my-app
          type: string
      type: object
    v2GetAppResponse:
      properties:
        data:
          $ref: '#/components/schemas/v2App'
        metadata:
          $ref: '#/components/schemas/v2ResponseMetadata'
      type: object
    v2AppMethod:
      default: UNSPECIFIED
      enum:
      - UNSPECIFIED
      - SERVE
      - CONNECT
      - API
      type: string
    v2ErrorResponse:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/v2Error'
          type: array
      type: object
    v2GetAppsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/v2App'
          type: array
        metadata:
          $ref: '#/components/schemas/v2ResponseMetadata'
        page:
          $ref: '#/components/schemas/v2Page'
      type: object
    v2ResponseMetadata:
      properties:
        cachedUntil:
          format: date-time
          type: string
        fetchedAt:
          format: date-time
          type: string
        timeRange:
          $ref: '#/components/schemas/v2TimeRange'
      type: object
    v2Error:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    v2Page:
      properties:
        cursor:
          type: string
        hasMore:
          type: boolean
        limit:
          format: int32
          type: integer
      type: object
    v2TimeRange:
      properties:
        from:
          format: date-time
          type: string
        until:
          format: date-time
          type: string
      type: object
    v2SyncAppResponse:
      properties:
        data:
          $ref: '#/components/schemas/v2SyncAppData'
        metadata:
          $ref: '#/components/schemas/v2ResponseMetadata'
      type: object
    V2SyncAppBody:
      properties:
        url:
          description: URL for the Inngest endpoint in the app
          example: https://example.com/api/inngest
          type: string
      type: object
    v2AppSync:
      properties:
        appVersion:
          description: App version reported by the latest sync, if set
          type: string
        error:
          description: Most recent sync or connectivity error for the app, if any
          type: string
        framework:
          description: Framework used by the app, if reported by the SDK
          example: nextjs
          type: string
        sdkLanguage:
          description: Language of the SDK that synced the app
          example: typescript
          type: string
        sdkVersion:
          description: Version of the SDK that synced the app
          example: 3.22.0
          type: string
        status:
          description: Status of the latest sync. `success` and `duplicate` are successful terminal states. `duplicate` means the sync payload matched the previous successful sync, so no function configuration changes were applied. `error` is a failed terminal state, and `pending` means the sync is still in progress.
          enum:
          - pending
          - success
          - error
          - duplicate
          type: string
        syncedAt:
          description: Timestamp for the latest sync, if available
          format: date-time
          type: string
        url:
          description: URL of the Inngest endpoint in the app, if synced via URL
          example: https://example.com/api/inngest
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer token authentication. Format: `Bearer {key}`'
      in: header
      name: Authorization
      type: apiKey
x-provenance:
  method: harvested
  publisher: Inngest
  source: https://api-docs.inngest.com/api-specs/v2.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)