API and webhooks for time data
The API answers requests for time logs and published shifts, up to 31 days per request and 200 rows per page. Webhooks post a clock-in or clock-out event to your https address as it happens.
Security guard software integrations
Guardix shares data with your other systems in three ways. A read-only API returns time logs and published shifts, signed webhooks tell your server the moment a guard clocks in or out, and file imports and exports move clients, post sites, expense lines, payroll and invoices as CSV, Excel or PDF.
Integrations & Data Connections
API keys and webhooks are set up for your company by Guardix support. File imports and exports are buttons in the web app, on the pages where that data lives.
The API answers requests for time logs and published shifts, up to 31 days per request and 200 rows per page. Webhooks post a clock-in or clock-out event to your https address as it happens.
Each time log carries the employee's ID and name, the post site, and clock-in and clock-out times in UTC. Each shift carries its title, post sites, start, end and assigned employees, so your system knows exactly what it received.
Each API key has its own scopes, such as time_logs:read or shifts:read, and can expire or be revoked. Webhooks are signed with HMAC-SHA256, so your server can reject any request that did not come from Guardix.
Export a payroll run to Excel or PDF, invoices for sales tax to CSV or Excel, and the invoice aging report to CSV. Import card statements and other transaction files as CSV, and Guardix flags possible duplicates before any expense is created.
Import clients and post sites from a CSV file built on the template Guardix provides. Each refused row is listed with its reason, such as a client name that does not match, so you can fix the file and upload again.
A failed webhook delivery is retried on a schedule over several hours, up to six tries in total. Each delivery has its own ID so your system can ignore repeats, and a webhook that keeps failing is switched off until support turns it back on.
The API answers requests for time logs and published shifts, up to 31 days per request and 200 rows per page. Webhooks post a clock-in or clock-out event to your https address as it happens.
Each time log carries the employee's ID and name, the post site, and clock-in and clock-out times in UTC. Each shift carries its title, post sites, start, end and assigned employees, so your system knows exactly what it received.
Each API key has its own scopes, such as time_logs:read or shifts:read, and can expire or be revoked. Webhooks are signed with HMAC-SHA256, so your server can reject any request that did not come from Guardix.
Export a payroll run to Excel or PDF, invoices for sales tax to CSV or Excel, and the invoice aging report to CSV. Import card statements and other transaction files as CSV, and Guardix flags possible duplicates before any expense is created.
Integrations & Data Connections
An integration involves your developers, Guardix support and your office staff, each at a different step.
Call the API with the key Guardix support issues, receive webhooks on your https server, and check each signature before acting on the event.
Creates API keys and webhooks for your company, chooses their scopes, and can send a test event or switch a failing webhook back on.
Import clients, post sites and transaction files, and export payroll, invoices and reports in the web app, within the rights their role gives them.
How it works
List what your other system needs: time logs, published shifts, clock-in events, or files such as payroll runs and invoices.
Guardix support creates the API key or webhook with the scopes you need. The key and the signing secret are shown only once.
Call the /api/v1/me/ route to check the key, and ask support to send a test webhook to your server.
Store each delivery ID to skip repeats, answer webhooks with a 2xx status, and fix your server quickly if deliveries start failing.
FAQ
No. Guardix has no built-in connection to an accounting or payroll provider. Payroll runs export to Excel or PDF, invoices export for sales tax as CSV or Excel, and transaction files from cards, banks or other systems import as CSV. Your team moves the files between systems.
Version 1 of the API is read-only. It returns your company and key details, clock-in sessions with employee, post site and clock times, and published shifts with their post sites and employees. One request covers up to 31 days, a page holds up to 200 rows, and each key can make 120 requests a minute.
A webhook sends an event when a guard clocks in and when a guard clocks out, plus a test event that support can trigger. Each POST carries a delivery ID and an HMAC-SHA256 signature. Each delivery gets up to six tries, and the webhook is switched off after 50 failed tries in a row.
Guardix support creates them for your company on request; there is no self-service screen for them in the web app. File imports and exports are in the web app, and each one follows the user's role. For example, only people who can edit clients can import clients.
Next step
Plan the supported connections your team needs to carry security operations into the wider business workflow.
Related