Quvia 360
Added in Version
v24.1.0Overview
To integrate Quvia 360 our new webhook service offers a generic way to send the needed ticket information to the Quvia system. Webhooks have been introduced with version 24.1.0 and can be used to send all ticket related events (login
, logout
, revoke
) to the Quvia webhook endpoint.
Prerequisites
On Quvia side you need a webhook endpoint which is setup by the Quvia team.
Setup
On the IACBOX a new webhook needs to be configured. This can be done by navigating to APIs -> Webhooks. From there you can create a new webhook with the following details:
General settings
- Name:
Quvia 360
- URL:
https://your-endpoint.quvia.ai/webhooks/quvia
- replace this with your actual endpoint URL you’ll get from the Quvia team - Method:
POST
- Events: Select these 5 events: Ticket Logged in, Logged out, Logged out (idle timout), Logged out (Limit exceeded), Revoked
- Body: Use this JSON payload:
{
"id":"{{event.uuid}}",
"event":"{{event.type}}",
"occured":"{{event.created_at}}",
"ticket_id":"{{event.ticket_id}}",
"data": {
"backend.pms.name":"{{backend_data.pms.name}}",
"backend.pms.room":"{{backend_data.pms.room}}",
"template_id":"{{template_id}}",
"template_name":"{{template_name}}",
"client_ip":"{{client_ip}}",
"client_mac":"{{client_mac}}",
"client_vlan_rt":"{{client_vlan_rt}}",
"login_type":"{{login_type}}",
"time_limit":"{{time_limit}}",
"time_used":"{{time_used}}",
"volume_limit":"{{volume_limit}}",
"volume_used":"{{volume_used}}"
}
}
- Body mime type:
application/json
- Log body and headers:
false
This is for debugging and can be enabled while testing.
Authentication settings
The Quvia webhook endpoint uses a JSON Web Token (JWT) for authentication.
- Authentication type:
Token (JWT)
- Authentication URL:
https://your-endpoint.quvia.ai/token
- Replace this with your actual authentication URL you’ll get from the Quvia team - Authentication method:
POST
- Authentication body: Use this from encoded payload:
grant_type=password&username={{auth.username}}&password={{auth.password}}
- Authentication body mime type:
application/x-www-form-urlencoded
- Authentication username:
insert-username-here
Given by Quvia - Authentication password:
insert-password-here
Given by Quvia - Authentication refresh interval: 30 (minutes)
- Authentication token field:
access_token
(exactely this string) - Validate TLS certificate:
true
(depends on setup - enable if possible, otherwise deactivate for self-signed certificates)
Checks
After the webhook service is setup and the webhook endpoint is working, you should see successful events in the Event Log tab. If there are errors (return code not 200), enable the option Log body and headers. With that option set the event log will also show the full response.
Setup Quvia Probes
- Probes need to be added as Static AutoLogin Devices found under Users/Tickets.
- Add them with their MAC address and a free IP chosen from the end of the DHCP range to avoid collisions with present devices.
- Set the up- and download bandwidth accordingly to the ticket template (aka. package or user group) this probe should represent
- Check unlimited volume