feat (samples/webhooks): Report 'webhooks' server template from quickstart repository

.github/workflows/samples-compilation.yaml

@@ -1,4 +1,4 @@
-name: Snippets Compilation
+name: Examples Compilation
 
 on: [push]
 

examples/compile.sh

@@ -1,3 +1,4 @@
 #!/bin/sh
 
 (cd snippets && ./compile.sh)  || exit 1
+(cd webhooks && ./compile.sh)  || exit 1

examples/webhooks/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip

examples/webhooks/README.md

@@ -0,0 +1,79 @@
+# Backend application built using Sinch Java SDK to handle incoming webhooks
+
+This directory contains a server application based onto [Sinch SDK java](https://github.com/sinch/sinch-sdk-java)
+
+## Requirements
+
+- JDK 21 or later (Sinch SDK Java is requiring java 8 only but client application can use latest available version)
+- [Maven](https://maven.apache.org/)
+- [SpringBoot](https://spring.io/projects/spring-boot)
+- [Sinch account](https://dashboard.sinch.com)
+- [ngrok](https://ngrok.com/docs)
+
+## Configuration
+
+### Configure application settings
+
+com.mycompany.app.Application settings are using the `SpringBoot` configuration file: [`application.yaml`](src/main/resources/application.yaml) file and enable to configure:
+
+#### Sinch credentials
+Located in `credentials` section (*you can find all of the credentials you need on your [Sinch dashboard](https://dashboard.sinch.com)*):
+- `project-id`: YOUR_project_id
+- `key-id`: YOUR_access_key_id
+- `key-secret`: YOUR_access_key_secret
+
+#### Server port
+<em>Default: 8090</em>
+
+Located in `server` section:
+- port: The port to be used to listen to incoming requests. <em>Default: 8090</em>
+
+## Usage
+
+### Start server
+1. Edit configuration file
+
+   See above for Configuration paragraph
+
+2. Start server locally.
+
+   Compile and run the application as server locally.
+   ```bash
+   ./mvnw clean spring-boot:run
+   ```
+### EndPoints
+When server is online, declared controllers will respond to following endpoints
+
+| Service                                                                                                                                                                | Endpoint          | 
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
+| [Conversation](https://developers.sinch.com/docs/conversation/callbacks)                                                                                               | /ConversationEvent |
+| [Numbers](https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Numbers-Callbacks/#tag/Numbers-Callbacks/operation/ImportedNumberService_EventsCallback) | /NumbersEvent     |
+| [SMS](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Webhooks/#tag/Webhooks/section/Callbacks)                                                            | /SmsEvent         |
+| [Verification](https://developers.sinch.com/docs/verification/api-reference/verification/tag/Verification-callbacks/)                                                  | /VerificationEvent |
+| [Voice](https://developers.sinch.com/docs/voice/api-reference/voice/tag/Callbacks/)                                                                                                                                                              | /VoiceEvent       |
+
+## Use ngrok to forward request to local server
+
+Forwarding request to same `8090` port used above:
+
+*Note: The `8090` value is coming from default config and can be changed (see [Server port](#Server port) configuration section)*
+
+```bash
+ngrok http 8090
+```
+
+ngrok output will contains output like:
+```
+ngrok                                                                                                                                                                                                                          (Ctrl+C to quit)
+
+...
+Forwarding                    https://0e64-78-117-86-140.ngrok-free.app -> http://localhost:8090
+
+```
+The line
+```
+Forwarding                    https://0e64-78-117-86-140.ngrok-free.app -> http://localhost:8090
+```
+Contains `https://0e64-78-117-86-140.ngrok-free.app` value.
+
+This value must be used to configure callback's URL from your [Sinch dashboard](https://dashboard.sinch.com/sms/api/services)

examples/webhooks/compile.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+mvn clean spotless:apply || exit 1
+
+./mvnw clean compile || exit 1