Queries / Security — Shopfront Developer Documentation

Query

securityEvent — Returns SecurityEvent

Arguments	Type	Description
id	ID!	The ID of the security event

Example Query

query GetSecurityEvent($id: ID!) {
    securityEvent(id: $id) {
        id,
        deviceId,
        event,
        metaData,
        ipv4
    }
}

# Example variables
{
    "id": "<ID>"
}

Query

securityEvents — Returns ConnectionType of SecurityEvent

Scopes Required: see_security_events

Arguments	Type	Description
outlets	[ID]	A list of outlets to filter the events by
registers	[ID]	A list of registers to filter the events by
users	[ID]	A list of users to filter the events by
eventsSince	DateTime	Get the events since this time (inclusive)
eventsBefore	DateTime	Get the events before this time (inclusive)

Example Query

query GetSecurityEvents($outlets: [ID]) {
    securityEvents(outlets: $outlets) {
        edges {
            node {
                id,
                deviceId,
                event,
                metaData,
                ipv4
            }
        },
        pageInfo {
            hasNextPage,
            endCursor
        }
    }
}

# Example variables
{
    "outlets": [
        "<OUTLETS>"
    ]
}