Rutter Logs API

openapi: 3.2.0
info:
  title: Rutter Logs API
  version: '2024-08-31'
  description: The Universal API for all major e-commerce platforms, accounting systems, and payment processors.
servers:
- url: https://production.rutterapi.com/versioned
  description: Production server
- url: https://sandbox.rutterapi.com/versioned
  description: Sandbox server
tags:
- name: Logs
paths:
  /logs/requests/{id}:
    get:
      summary: Fetch request
      operationId: fetchRequest
      parameters:
      - name: id
        in: path
        required: true
        description: The Rutter generated unique ID of the object.
        schema:
          $ref: '#/components/schemas/RutterIdPathParams/properties/id'
      responses:
        '200':
          description: Fetches a single logged API request by id. Credential-shaped values in headers, params, body, and response fields are redacted. Lookups are limited to recently made requests — a request outside that window, belonging to a different organization, or that doesn't exist is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRequestResponse'
      x-supported-platforms:
      - '*'
      x-sandbox-supported-platforms:
      - NETSUITE
      - QUICKBOOKS
      tags:
      - Logs
      x-summary-source: derived
  /logs/webhooks:
    get:
      summary: List webhook logs
      operationId: listWebhookLogs
      parameters:
      - name: item_id
        in: query
        required: true
        description: ID of the connection to return webhook delivery logs for.
        schema:
          $ref: '#/components/schemas/ListWebhookLogsQueryParams/properties/item_id'
      - name: limit
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ListWebhookLogsQueryParams/properties/limit'
      - name: page
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ListWebhookLogsQueryParams/properties/page'
      - name: start_time
        in: query
        required: false
        description: ISO 8601 timestamp with a timezone marking the inclusive start of a one-hour webhook creation-time window. Must be in the recent past. The window ends one hour after start_time, exclusively. Defaults to one hour ago.
        schema:
          $ref: '#/components/schemas/ListWebhookLogsQueryParams/properties/start_time'
      - name: success
        in: query
        required: false
        description: Filter to only successful (or only failed) deliveries.
        schema:
          $ref: '#/components/schemas/ListWebhookLogsQueryParams/properties/success'
      - name: webhook_type
        in: query
        required: false
        description: Filter to a single webhook type, e.g. `ORDER_CREATED`.
        schema:
          $ref: '#/components/schemas/ListWebhookLogsQueryParams/properties/webhook_type'
      responses:
        '200':
          description: Returns recent webhook delivery logs for the given connection within a one-hour creation-time window. Defaults to the most recent hour. Use start_time to select an earlier window within the available history. `time_window` reports the window that was searched, and `has_more` reports whether another page follows. Credential-shaped values in URLs are redacted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookLogsResponse'
      x-supported-platforms:
      - '*'
      x-sandbox-supported-platforms:
      - NETSUITE
      - QUICKBOOKS
      tags:
      - Logs
      x-summary-source: derived
  /logs/webhooks/{id}:
    get:
      summary: Fetch webhook log
      operationId: fetchWebhookLog
      parameters:
      - name: id
        in: path
        required: true
        description: The Rutter generated unique ID of the object.
        schema:
          $ref: '#/components/schemas/RutterIdPathParams/properties/id'
      responses:
        '200':
          description: Fetches a single webhook delivery log by id, including its delivery attempts. Credential-shaped values in the payload, attempt bodies, response headers/bodies, and URLs are redacted. Lookups are limited to recently fired webhooks — an id outside that window, belonging to a different organization, or that doesn't exist is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebhookLogResponse'
      x-supported-platforms:
      - '*'
      x-sandbox-supported-platforms:
      - NETSUITE
      - QUICKBOOKS
      tags:
      - Logs
      x-summary-source: derived
components:
  schemas:
    WebhookLogTimeWindow:
      type: object
      properties:
        end:
          type: string
          description: Exclusive end of the creation-time window that was searched, as an ISO 8601 UTC timestamp.
        start:
          type: string
          description: Inclusive start of the creation-time window that was searched, as an ISO 8601 UTC timestamp.
      required:
      - end
      - start
      description: The creation-time window this query actually searched. An empty `webhook_logs` means no delivery matched inside this window, not that the connection has never fired webhooks.
    Request:
      type: object
      properties:
        apiVersion:
          type: string
        asyncResponseBody: {}
        createdAt:
          type: string
        intermediateRequestData: {}
        organizationId:
          type: string
        query: {}
        responseBody: {}
        responseError: {}
        updatedAt:
          type: string
        asyncResponseCode:
          type:
          - number
          - 'null'
        body:
          type:
          - string
          - 'null'
        createdRutterId:
          type:
          - string
          - 'null'
        error:
          type:
          - string
          - 'null'
        headers:
          type:
          - string
          - 'null'
        httpMethod:
          type:
          - string
          - 'null'
        itemId:
          type:
          - string
          - 'null'
        params:
          type:
          - string
          - 'null'
        path:
          type:
          - string
          - 'null'
        platform:
          type:
          - string
          - 'null'
        responseStatusCode:
          type:
          - number
          - 'null'
        route:
          type:
          - string
          - 'null'
        jobData:
          type:
          - object
          - 'null'
          properties:
            id:
              type: string
            idempotencyKey:
              type:
              - string
              - 'null'
            executionProgress:
              type:
              - object
              - 'null'
              properties:
                platformInput: {}
                platformOutput: {}
                rutterEntity:
                  type: string
                superInput: {}
                superOutput: {}
              additionalProperties: false
          required:
          - id
          - idempotencyKey
          - executionProgress
          additionalProperties: false
      required:
      - apiVersion
      - createdAt
      - organizationId
      - updatedAt
      - asyncResponseCode
      - body
      - createdRutterId
      - error
      - headers
      - httpMethod
      - itemId
      - params
      - path
      - platform
      - responseStatusCode
      - route
      - jobData
    GetWebhookLogResponse:
      type: object
      properties:
        webhook_log:
          $ref: '#/components/schemas/WebhookLogDetail'
      required:
      - webhook_log
      description: Fetches a single webhook delivery log by id, including its delivery attempts. Credential-shaped values in the payload, attempt bodies, response headers/bodies, and URLs are redacted. Lookups are limited to recently fired webhooks — an id outside that window, belonging to a different organization, or that doesn't exist is not found.
    WebhookAttempt:
      type: object
      properties:
        id:
          type: string
          format: uuid
        webhook_config_id:
          type: string
          format: uuid
        attempt_number:
          type: number
        duration_ms:
          type: number
        request_body: {}
        request_start_time:
          type: string
        url:
          type: string
        did_truncate_response_body:
          type:
          - boolean
          - 'null'
        network_error_code:
          type:
          - string
          - 'null'
        response_body:
          type:
          - string
          - 'null'
        response_headers:
          type:
          - string
          - 'null'
        status_code:
          type:
          - number
          - 'null'
      required:
      - id
      - webhook_config_id
      - attempt_number
      - duration_ms
      - request_start_time
      - url
      - did_truncate_response_body
      - network_error_code
      - response_body
      - response_headers
      - status_code
    ListWebhookLogsQueryParams:
      type: object
      properties:
        item_id:
          type: string
          format: uuid
          description: ID of the connection to return webhook delivery logs for.
        limit:
          type: integer
        page:
          type: integer
        start_time:
          type: string
          description: ISO 8601 timestamp with a timezone marking the inclusive start of a one-hour webhook creation-time window. Must be in the recent past. The window ends one hour after start_time, exclusively. Defaults to one hour ago.
        success:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Filter to only successful (or only failed) deliveries.
        webhook_type:
          type: string
          description: Filter to a single webhook type, e.g. `ORDER_CREATED`.
      required:
      - item_id
    RutterIdPathParams:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The Rutter generated unique ID of the object.
      required:
      - id
    WebhookLogDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
        item_id:
          type: string
          format: uuid
        resource_id:
          type:
          - string
          - 'null'
        next_attempt_at:
          type:
          - string
          - 'null'
        actual_body: {}
        payload: {}
        retry_amount:
          type: number
        success:
          type: boolean
        url:
          type: string
        webhook_type:
          type: string
        attempts:
          type: array
          items:
            $ref: '#/components/schemas/WebhookAttempt'
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - item_id
      - resource_id
      - next_attempt_at
      - retry_amount
      - success
      - url
      - webhook_type
      - attempts
      - created_at
      - updated_at
    ListWebhookLogsResponse:
      type: object
      properties:
        limit:
          type: number
          description: The page size this response used, whether it was requested or defaulted.
        has_more:
          type: boolean
          description: Whether another page exists after this one within the same window and filters. `false` marks the end of the results.
        page:
          type: number
          description: The 1-based page this response returns, whether it was requested or defaulted.
        time_window:
          $ref: '#/components/schemas/WebhookLogTimeWindow'
        webhook_logs:
          type: array
          items:
            $ref: '#/components/schemas/WebhookLogSummary'
      required:
      - limit
      - has_more
      - page
      - time_window
      - webhook_logs
      description: Returns recent webhook delivery logs for the given connection within a one-hour creation-time window. Defaults to the most recent hour. Use start_time to select an earlier window within the available history. `time_window` reports the window that was searched, and `has_more` reports whether another page follows. Credential-shaped values in URLs are redacted.
    GetRequestResponse:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/Request'
      required:
      - request
      description: Fetches a single logged API request by id. Credential-shaped values in headers, params, body, and response fields are redacted. Lookups are limited to recently made requests — a request outside that window, belonging to a different organization, or that doesn't exist is not found.
    WebhookLogSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        item_id:
          type: string
          format: uuid
        resource_id:
          type:
          - string
          - 'null'
        next_attempt_at:
          type:
          - string
          - 'null'
        retry_amount:
          type: number
        success:
          type: boolean
        url:
          type: string
        webhook_type:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - item_id
      - resource_id
      - next_attempt_at
      - retry_amount
      - success
      - url
      - webhook_type
      - created_at
      - updated_at