Skip to main content

External connectivity

What is External Connectivity?​

External Connectivity lets you connect Reservation.Studio to external apps and services in a structured and standardized way. With this capability, you gain access to up‑to‑date data, automate operations, and extend your business software ecosystem.

What you'll learn​

  • How to use the JSON:API endpoints for reading and writing data.
  • How to configure webhooks and process real-time events.
  • How to secure integrations with API keys, scopes, and monitoring.
tip

Communication follows the JSON:API standard—a popular, easy‑to‑integrate architecture for RESTful APIs—as well as outbound web notifications (webhooks) for specific events.

What is the JSON:API integration?​

Key advantages:​

  • Structured access to all key system resources (read, create, update, delete).
  • Unified approach to requests and responses—communication is in JSON and follows the jsonapi.org specification.
  • Easy integration with external/internal systems, mobile apps, and automated processes.

How to use JSON:API?​

  1. Authentication and security

    • Access is secured with API keys (or OAuth, depending on configuration).
    • Each user/integration can have its own key with specific permissions.

  2. Operations

    • You can perform GET, POST, PATCH, DELETE requests against described resources.
    • Filtering, sorting, pagination, and including related entities are supported.

    Example:

    GET /api/v1/resources?filter[status]=active
    Accept: application/vnd.api+json
    Authorization: Bearer <YOUR_API_KEY>

    Response:

    {
      "data": [
        {
          "type": "resource",
          "id": "1",
          "attributes": {
            "name": "Sample resource",
            "status": "active"
          }
        }
      ]
    }

How do Webhooks work?​

Webhooks let your external system receive real‑time notifications when a specific event occurs (e.g., user created, data updated, etc.).

Main steps​

  1. Configure the webhook URL
    In the admin panel, set the URL where your external system will receive notifications.

  2. Receive messages
    On events, the system sends a POST request with an appropriate JSON payload:

    {
      "event": "user.created",
      "timestamp": "2024-06-10T14:00:00Z",
      "data": {
        "id": 123,
        "email": "user@example.com"
      }
    }

  3. Process events
    The received information can trigger automated actions in the external system—for example, creating a user profile.

Benefits​

  • Automation & integration – connect to payment gateways, CRMs, ERPs, BI tools, and more.
  • Reliability – standardized JSON:API protocol and resilient webhook mechanisms.
  • Scalability – suitable for both small integrations and large enterprise architectures.

Frequently asked questions

What systems can be integrated?

Any system that supports a RESTful API or can receive HTTP POST requests with JSON payloads.

Is special configuration required?

Generating an API key via the standard steps is sufficient, along with an external system capable of handling JSON webhooks.

Can access be controlled?

Yes. The platform supports permission and scope controls per key and per user.
note

For additional information on integrating external systems and for implementation support, please contact our team.