Webhook Configuration

Defining webhooks for processes and status updates occuring in the portal. Information on the data submitted as part of the webhook call is defined in the POST webhookconfig under 'Callback payload samples'

Retrieve all or a specific webhook configurations

get

https://api-dev.gemeindeconnect.ch/legacyhttps://api.gemeindeconnect.ch/legacy

/webhookconfig

This action retrieves a list of configured webhooks

Authorizations

subscriptionkey

Ocp-Apim-Subscription-KeystringRequired

Retrieve your subscription key from the APIM developer portal or contact Support.

Query parameters

whidstringOptional

pass an optional webhook configuration id to retrieve a selected configuration

Responses

200

successfully found the webhook configuration

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

A server side exception has occured, please contact support

application/json

get

/webhookconfig

HTTPcURLJavaScriptPython

GET /legacy/webhookconfig HTTP/1.1
Host: api-dev.gemeindeconnect.ch
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

[
  {
    "whid": "A123123",
    "whname": "Your Alert Name",
    "whcomment": "short comment on the alert",
    "applicationId": "d0db4b13-20d4-42c3-8268-37db22b36f98",
    "municipalityid": "d0db4b13-20d4-42c3-8268-37db22b36f98",
    "callbackUrl": "https://yourdomain.com/send/callback/here",
    "process": "process",
    "httprequestheaders": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "httprequestparameter": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "httprequestbody": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  }
]

Create a new webhook configuration

post

https://api-dev.gemeindeconnect.ch/legacyhttps://api.gemeindeconnect.ch/legacy

/webhookconfig

This endpoint allows you to create a new webhook. Webhooks allow you to specify a url to receive notifications for event types.

Authorizations

subscriptionkey

Ocp-Apim-Subscription-KeystringRequired

Retrieve your subscription key from the APIM developer portal or contact Support.

Body

application/json

whnamestringRequiredExample: Your Webhook Name

whcommentstringRequiredExample: short comment on the webhook

applicationIdstringRequiredExample: d0db4b13-20d4-42c3-8268-37db22b36f98

municipalityIdstringRequired

The municipalityId for which the event is triggered.

Example: d0db4b13-20d4-42c3-8268-37db22b36f98

callbackUrlstring · uriRequiredExample: https://yourdomain.com/send/callback/here

processesstring[]Required

One or more processId for which the webhook is called for. The processId retrieved from the processes api call.

Responses

200

webhook created

application/json

400

invalid input, object invalid

application/json

401

Unauthorized

application/json

500

A server side exception has occured, please contact support

application/json

post

/webhookconfig

HTTPcURLJavaScriptPython

POST /legacy/webhookconfig HTTP/1.1
Host: api-dev.gemeindeconnect.ch
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 421

{
  "whname": "Your Webhook Name",
  "whcomment": "short comment on the webhook",
  "applicationId": "d0db4b13-20d4-42c3-8268-37db22b36f98",
  "municipalityId": "d0db4b13-20d4-42c3-8268-37db22b36f98",
  "callbackUrl": "https://yourdomain.com/send/callback/here",
  "processes": [
    "text"
  ],
  "httprequestheaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "httprequestparameter": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "httprequestbody": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

{
  "whid:": 20
}

Delete a webhook configuration

delete

https://api-dev.gemeindeconnect.ch/legacyhttps://api.gemeindeconnect.ch/legacy

/webhookconfig

This action deletes a specific webhook

Authorizations

subscriptionkey

Ocp-Apim-Subscription-KeystringRequired

Retrieve your subscription key from the APIM developer portal or contact Support.

Query parameters

whidstringRequired

pass a webhook configuration id to delete the configuration

Responses

200

webhook deleted

400

Bad request

application/json

401

Unauthorized

application/json

500

A server side exception has occured, please contact support

application/json

delete

/webhookconfig

HTTPcURLJavaScriptPython

DELETE /legacy/webhookconfig?whid=text HTTP/1.1
Host: api-dev.gemeindeconnect.ch
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

No content

Update a new webhook configuration

patch

https://api-dev.gemeindeconnect.ch/legacyhttps://api.gemeindeconnect.ch/legacy

/webhookconfig

This endpoint allows you to update a webhook.

Authorizations

subscriptionkey

Ocp-Apim-Subscription-KeystringRequired

Retrieve your subscription key from the APIM developer portal or contact Support.

Query parameters

whidstringRequired

pass a webhook configuration id to update a selected configuration

Body

application/json

whnamestringRequiredExample: Your Webhook Name

whcommentstringRequiredExample: short comment on the webhook

applicationIdstringRequiredExample: d0db4b13-20d4-42c3-8268-37db22b36f98

municipalityIdstringRequired

The municipalityId for which the event is triggered.

Example: d0db4b13-20d4-42c3-8268-37db22b36f98

callbackUrlstring · uriRequiredExample: https://yourdomain.com/send/callback/here

processesstring[]Required

One or more processId for which the webhook is called for. The processId retrieved from the processes api call.

Responses

200

alert created

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

A server side exception has occured, please contact support

application/json

patch

/webhookconfig

HTTPcURLJavaScriptPython

PATCH /legacy/webhookconfig?whid=text HTTP/1.1
Host: api-dev.gemeindeconnect.ch
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 421

{
  "whname": "Your Webhook Name",
  "whcomment": "short comment on the webhook",
  "applicationId": "d0db4b13-20d4-42c3-8268-37db22b36f98",
  "municipalityId": "d0db4b13-20d4-42c3-8268-37db22b36f98",
  "callbackUrl": "https://yourdomain.com/send/callback/here",
  "processes": [
    "text"
  ],
  "httprequestheaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "httprequestparameter": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "httprequestbody": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

{
  "whid": "A123123",
  "whname": "Your Alert Name",
  "whcomment": "short comment on the alert",
  "applicationId": "d0db4b13-20d4-42c3-8268-37db22b36f98",
  "municipalityid": "d0db4b13-20d4-42c3-8268-37db22b36f98",
  "callbackUrl": "https://yourdomain.com/send/callback/here",
  "process": "process",
  "httprequestheaders": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "httprequestparameter": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "httprequestbody": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}