> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
> Use this file to discover all available pages before exploring further.

# Create or update the Honeywell OnGuard integration

> Idempotent activation/update endpoint called by the OnGuard side from its setup tool. Generates the webhook token and pre-shared HMAC secret on first call; preserves both on subsequent calls so the deployed DLL keeps working as the door mapping changes. The request owns the door mapping; behavior flags (face recognition, clip saving, etc.) are managed separately from the Rhombus console.



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/integrations/accessControl/createOrUpdateHoneywellOnGuardIntegration
openapi: 3.0.1
info:
  contact:
    email: developer@rhombussystems.com
  description: >-
    This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token`
    for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```
  title: Rhombus API
  version: '1.0'
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/integrations/accessControl/createOrUpdateHoneywellOnGuardIntegration:
    post:
      tags:
        - Access Control Integrations Webservice
      summary: Create or update the Honeywell OnGuard integration
      description: >-
        Idempotent activation/update endpoint called by the OnGuard side from
        its setup tool. Generates the webhook token and pre-shared HMAC secret
        on first call; preserves both on subsequent calls so the deployed DLL
        keeps working as the door mapping changes. The request owns the door
        mapping; behavior flags (face recognition, clip saving, etc.) are
        managed separately from the Rhombus console.
      operationId: createOrUpdateHoneywellOnGuardIntegration
      parameters:
        - description: >-
            Authentication scheme identifier. Use `api-token` for standard API
            key authentication, `partner-api-token` for partner API key
            authentication. Must be paired with the `x-auth-apikey` header
            containing your API key.
          example: api-token
          in: header
          name: x-auth-scheme
          required: true
          schema:
            type: string
            default: api-token
            enum:
              - api-token
              - api
              - partner-api-token
              - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSRequest
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSResponse
          description: OK
components:
  schemas:
    Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSRequest:
      type: object
      description: >-
        Idempotent create-or-update of one OnGuard deployment for the calling
        org. An org can have multiple deployments connected at the same time
        (separate panels, MSP tenants, etc.) — each deployment is identified by
        its own rhombusToken. On first activation for a deployment, omit
        rhombusToken; the server generates one and returns it in the response.
        On subsequent calls, send the previously-returned rhombusToken to update
        the same deployment's door mapping in place. Map keys are the OnGuard
        door identifiers; values follow the standard Rhombus badge-integration
        door info shape.
      properties:
        displayName:
          type: string
          nullable: true
        doorInfoMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BadgeIntegrationDoorInfoType'
          nullable: true
        rhombusToken:
          type: string
          nullable: true
    Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSResponse:
      type: object
      description: >-
        Result of activating or updating the Honeywell OnGuard integration.
        Returns the webhook URL, token, and pre-shared secret to configure on
        the OnGuard side. Token and secret are stable across re-calls so the
        deployed DLL keeps working when the door mapping changes.
      properties:
        error:
          type: boolean
          nullable: true
        errorMsg:
          type: string
          nullable: true
        misconfiguredDoors:
          type: array
          items:
            type: string
            nullable: true
          nullable: true
        presharedSecret:
          type: string
          nullable: true
        rhombusToken:
          type: string
          nullable: true
        warningMsg:
          type: string
          nullable: true
        webhookUrl:
          type: string
          nullable: true
    BadgeIntegrationDoorInfoType:
      type: object
      nullable: true
      properties:
        assignedCameraList:
          type: array
          items:
            type: string
            format: RUUID
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            nullable: true
          nullable: true
        clipDuration:
          type: integer
          format: int32
          nullable: true
        doorName:
          type: string
          nullable: true
        leadingSeconds:
          type: integer
          format: int32
          nullable: true
        locationUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        remoteUnlock:
          type: boolean
          nullable: true
        subLocationsHierarchyKey:
          type: string
          format: SubLocationsHierarchyKey
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header
        set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey

````