Skip to content

Introduction

Social WiFi API can be used to programmatically retrieve and modify data. The API consists of two parts:

  • Webhooks
  • REST API

Webhooks

Webhooks allow building user data capture integrations. In this scenario, Social WiFi pushes the data as soon as we receive it (e.g. a guest logs in to the WiFi). They're mainly used for live data processing.

When to use Webhooks?

Use Webhooks, if you want Social WiFi to push data to you as soon as possible. Use them, if you prefer data being pushed to you, instead of you polling Social WiFi REST API for fresh data.

Webhooks are perfect for creating a proxy between Social WiFi and a database, a CRM or any other service that we don't integrate directly with. You will need to expose an HTTP endpoint that will accept data from Social WiFi.

Please see the Webhooks section for further details.

REST API

The REST API allows building more complex solutions, that can fully manage the venues and all related components. In this scenario, it's your code that initiates the communication with Social WiFi API.

When to use REST API?

Use the REST API if you need a more generic solution, not oriented around live user data capture, like Webhooks. With the REST API, you can do everything that the Client panel does, sometimes even more. You can fully manage the venues and all the components, that includes not only reading the data, but also modifying it.

Please see the REST API Overview section for further details.