Integrations

Navixy Repository API is a work in progress. This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.

Integration accounts for API clients, automated systems, and third-party service connections.

Queries

integration

Retrieves an integration by its ID.

integration(id: ID!): Integration

Arguments

Name	Type	Description
id	ID!	The ID of the integration to retrieve.

Output types:

Integration

An external system integration with API access.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The display name of the actor.
organization	Organization!	The organization this integration belongs to.
credentialRef	String	A reference to credentials stored in a secure vault.
isActive	Boolean!	Whether this integration is active.

Organization (entity)

An organization in the hierarchy that owns entities and users.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
externalId	String	An external system identifier for integration purposes.
isActive	Boolean!	Whether this organization is active.
features	[OrganizationFeature!]!	The feature flags enabled for this organization.
parent	Organization	The parent organization in the hierarchy. Null for root organizations.
children	OrganizationConnection!	The child organizations.
members	MemberConnection!	The members of this organization.
devices	DeviceConnection!	The devices owned by this organization.
assets	AssetConnection!	The assets owned by this organization.
geoObjects	GeoObjectConnection!	The geographic objects owned by this organization.
schedules	ScheduleConnection!	The schedules owned by this organization.

---

integrations

Lists integrations for an organization.

integrations(
    organizationId: ID!
    filter: IntegrationFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: IntegrationOrder = { field: TITLE, direction: ASC }
  ): IntegrationConnection!

Arguments

Name	Type	Description
organizationId	ID!	The organization to retrieve integrations for.
filter	IntegrationFilter	Filtering options for the returned integrations.
first	Int	The first n elements from the paginated list.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	IntegrationOrder	The ordering options for the returned integrations.

Input types:

IntegrationFilter

Filtering options for integrations.

Field	Type	Description
isActive	Boolean	Filter by active status.

IntegrationOrder

Ordering options for integrations.

Field	Type	Description
field	IntegrationOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

IntegrationConnection

A paginated list of Integration items.

Implements: Connection

Field	Type	Description
edges	[IntegrationEdge!]!	A list of edges.
nodes	[Integration!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

PageInfo (entity)

Information about the current page in a paginated connection.

Field	Type	Description
hasNextPage	Boolean!	Whether more items exist after the current page.
hasPreviousPage	Boolean!	Whether more items exist before the current page.
startCursor	String	The cursor pointing to the first item in the current page.
endCursor	String	The cursor pointing to the last item in the current page.

---

Mutations

integrationCreate

Creates a new integration.

integrationCreate(
    input: IntegrationCreateInput!
  ): IntegrationPayload

Arguments

Name	Type	Description
input	IntegrationCreateInput!	The input fields for creating the integration.

Input types:

IntegrationCreateInput

Input for creating a new integration.

Field	Type	Description
organizationId	ID!	The organization that will own the integration.
title	String!	The display name.
credentialRef	String	A reference to credentials in a secure vault.

Output types:

IntegrationPayload

The result of an integration mutation.

Field	Type	Description
integration	Integration!	The created or updated integration.

Integration (entity)

An external system integration with API access.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The display name of the actor.
organization	Organization!	The organization this integration belongs to.
credentialRef	String	A reference to credentials stored in a secure vault.
isActive	Boolean!	Whether this integration is active.

---

integrationUpdate

Updates an existing integration.

integrationUpdate(
    input: IntegrationUpdateInput!
  ): IntegrationPayload

Arguments

Name	Type	Description
input	IntegrationUpdateInput!	The input fields for updating the integration.

Input types:

IntegrationUpdateInput

Input for updating an existing integration.

Field	Type	Description
id	ID!	The integration ID to update.
version	Int!	The current version for optimistic locking.
title	String	The new display name.
credentialRef	String	The new credential reference.
isActive	Boolean	The new active status.

Output types:

IntegrationPayload

The result of an integration mutation.

Field	Type	Description
integration	Integration!	The created or updated integration.

Integration (entity)

An external system integration with API access.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The display name of the actor.
organization	Organization!	The organization this integration belongs to.
credentialRef	String	A reference to credentials stored in a secure vault.
isActive	Boolean!	Whether this integration is active.

---

integrationDelete

Deletes an integration.

integrationDelete(
    input: IntegrationDeleteInput!
  ): DeletePayload

Arguments

Name	Type	Description
input	IntegrationDeleteInput!	The input fields for deleting the integration.

Input types:

IntegrationDeleteInput

Input for deleting an integration.

Field	Type	Description
id	ID!	The integration ID to delete.
version	Int!	The current version for optimistic locking.

Output types:

DeletePayload

The result of a delete mutation.

Field	Type	Description
deletedId	ID!	The ID of the deleted entity.

---

Objects

Integration

An external system integration with API access.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The display name of the actor.
organization	Organization!	The organization this integration belongs to.
credentialRef	String	A reference to credentials stored in a secure vault.
isActive	Boolean!	Whether this integration is active.

---

IntegrationPayload

The result of an integration mutation.

Field	Type	Description
integration	Integration!	The created or updated integration.

---

Inputs

IntegrationFilter

Filtering options for integrations.

Field	Type	Description
isActive	Boolean	Filter by active status.

---

IntegrationOrder

Ordering options for integrations.

Field	Type	Description
field	IntegrationOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

---

IntegrationCreateInput

Input for creating a new integration.

Field	Type	Description
organizationId	ID!	The organization that will own the integration.
title	String!	The display name.
credentialRef	String	A reference to credentials in a secure vault.

---

IntegrationUpdateInput

Input for updating an existing integration.

Field	Type	Description
id	ID!	The integration ID to update.
version	Int!	The current version for optimistic locking.
title	String	The new display name.
credentialRef	String	The new credential reference.
isActive	Boolean	The new active status.

---

IntegrationDeleteInput

Input for deleting an integration.

Field	Type	Description
id	ID!	The integration ID to delete.
version	Int!	The current version for optimistic locking.

---

Enums

IntegrationOrderField

Fields available for ordering integrations.

Value	Description
TITLE	Order by title.

---

Pagination types

IntegrationConnection

A paginated list of Integration items.

Implements: Connection

Field	Type	Description
edges	[IntegrationEdge!]!	A list of edges.
nodes	[Integration!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

IntegrationEdge

An edge in the Integration connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Integration!	The integration at the end of the edge.

---