Changes to Previous API

Purpose

Gemeinde-Connect continues to support the Legacy API to ensure that existing third-party backend integrations can continue to operate without requiring changes.

The Legacy API allows existing integrations to:

• receive submitted form data via webhook callbacks

• send status updates back to the platform

The primary goal is to preserve compatibility with existing implementations.

Authentication changes

Previously, most API calls required two authentication headers:

• Ocp-Apim-Subscription-Key

• Authorization: Bearer <token>

Current behaviour in Gemeinde-Connect

• Only Ocp-Apim-Subscription-Key is required

• Authorization: Bearer <token> is still accepted for compatibility, but not mandatory. It is kept for backwards compatibility for the headers. But is ignored by the server.

To obtain a valid subscription key, please contact support.

Available functionality

The Legacy API in Gemeinde-Connect provides the following core functions:

Webhook Configuration

Webhook configurations can be created and managed to receive notifications when a new form is submitted.

When a webhook is triggered:

• Gemeinde-Connect sends the form data to the configured callback URL

• Data is automatically mapped from the new Form Designer data model to the legacy payload structure

• Existing backend integrations can continue using their current payload parsing logic

Status Update

Integrations can send status updates back to Gemeinde-Connect to update the state of a task.

Status updates are used to:

• reflect processing progress in the platform

• propagate status changes back to the portal and, where applicable, to the citizen

Functionality no longer available

The following API endpoints and functions are not available in Gemeinde-Connect.

Vendor Registration

• Vendor registration via API is not supported

• Please contact support to onboard or register a vendor

App Registration

• App registration via API is not supported

• Please contact support to configure application registration

Supporting Functions

Supporting functions are not exposed via API and are handled during onboarding.

List of municipalities

• Not available via API

• The list of supported municipalities is provided during onboarding

• Please contact support if municipalities need to be enabled or verified

List of processes

• Not available via API

• The following processes are currently supported:

  • Niederlassungsbescheinigung bestellen (Hauptwohnsitzbescheinigung)

  • Adressauskunft bestellen

  • Ratenzahlung / Stundung für die definitiven Gemeindesteuern beantragen

Submit Document

• The Submit Document function is not supported in Gemeinde-Connect

• Document delivery is handled internally by the platform

Summary for integrators

• Existing webhook integrations continue to work

• Status updates can still be submitted

• Only a subscription key is required for authentication

• Vendor, app registration, and supporting lookup APIs are no longer available

• Document submission is not supported