Mutations / Security — Shopfront Developer Documentation

Mutation

createSecurityEvent — Returns SecurityEvent

No scope required

Arguments	Type	Description
outlet	ID	The outlet the security event occurred in
register	ID	The register the security event occurred on
user	ID	The user who caused the event, if not specified it defaults to the current user
event	SecurityEventEnum!	The event that occurred, if specifying your own event, use the CUSTOM_EVENT type
customEvent	String	The custom event that occurred, only specify when using the CUSTOM_EVENT type
metaData	JSON	Any internal data relating to the event
ipv4	IPv4	The IPv4 Address this event originated from, if not specified it will use the current request's IPv4 address
ipv6	IPv6	The IPv6 Address this event originated from, if not specified this will use the current request's IPv6 address
timestamp	DateTime	The timestamp this event occurred, if not specified it will use the current timestamp

Example Mutation

mutation CreateSecurityEvent($event: SecurityEventEnum!) {
    createSecurityEvent(event: $event) {
        id,
        deviceId,
        event,
        metaData,
        ipv4
    }
}

# Example variables
{
    "event": "LOGIN"
}