# [Not Implemented] Register webhook

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/webhooks/subscriptions/llms.txt.
> For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/webhooks/subscriptions/llms-full.txt.

POST http://localhost:8080/api/v1/webhooks/subscriptions
Content-Type: application/json

> **Status: Not Implemented**

Register an external endpoint URL to receive webhook events.
The registered URL will receive an HTTP POST with a standard event envelope
whenever a subscribed event occurs.

**Verification:** After registration, this service sends a `ping` event to the
registered URL to verify it is reachable. The endpoint must respond with `200 OK`.


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/webhooks/subscriptions/not-implemented-register-webhook

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/webhooks/subscriptions:
    post:
      operationId: not-implemented-register-webhook
      summary: '[Not Implemented] Register webhook'
      description: >
        > **Status: Not Implemented**


        Register an external endpoint URL to receive webhook events.

        The registered URL will receive an HTTP POST with a standard event
        envelope

        whenever a subscribed event occurs.


        **Verification:** After registration, this service sends a `ping` event
        to the

        registered URL to verify it is reachable. The endpoint must respond with
        `200 OK`.
      tags:
        - >-
          subpackage_api.subpackage_api/v1.subpackage_api/v1/webhooks.subpackage_api/v1/webhooks/subscriptions
      parameters:
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: X-Tenant-ID
          in: header
          description: Tenant identifier
          required: false
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api_v1_webhooks_subscriptions_[Not
                  Implemented] Register webhook_Response_201
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1WebhooksSubscriptionsRequestBadRequestError
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1WebhooksSubscriptionsRequestUnauthorizedError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                events:
                  type: array
                  items:
                    type: string
                secret:
                  type: string
                description:
                  type: string
              required:
                - url
                - events
                - secret
                - description
servers:
  - url: http://localhost:8080
components:
  schemas:
    api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_Response_201:
      type: object
      properties:
        subscriptionId:
          type: string
        url:
          type: string
          format: uri
        events:
          type: array
          items:
            type: string
        description:
          type: string
        status:
          type: string
        tenantId:
          type: string
        createdAt:
          type: string
          format: date-time
      required:
        - subscriptionId
        - url
        - events
        - description
        - status
        - tenantId
        - createdAt
      title: >-
        api_v1_webhooks_subscriptions_[Not Implemented] Register
        webhook_Response_201
    ApiV1WebhooksSubscriptionsPostResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: ApiV1WebhooksSubscriptionsPostResponsesContentApplicationJsonSchemaError
    PostApiV1WebhooksSubscriptionsRequestBadRequestError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1WebhooksSubscriptionsPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: PostApiV1WebhooksSubscriptionsRequestBadRequestError
    PostApiV1WebhooksSubscriptionsRequestUnauthorizedError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1WebhooksSubscriptionsPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: PostApiV1WebhooksSubscriptionsRequestUnauthorizedError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
import requests

url = "http://localhost:8080/api/v1/webhooks/subscriptions"

payload = {
    "url": "https://your-system.com/webhooks/pos",
    "events": ["order.created", "order.failed", "order.status_changed"],
    "secret": "whsec_your_secret_here",
    "description": "Cata order notifications"
}
headers = {
    "X-Tenant-ID": "string",
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
const url = 'http://localhost:8080/api/v1/webhooks/subscriptions';
const options = {
  method: 'POST',
  headers: {
    'X-Tenant-ID': 'string',
    'X-Api-Key': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"url":"https://your-system.com/webhooks/pos","events":["order.created","order.failed","order.status_changed"],"secret":"whsec_your_secret_here","description":"Cata order notifications"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/webhooks/subscriptions"

	payload := strings.NewReader("{\n  \"url\": \"https://your-system.com/webhooks/pos\",\n  \"events\": [\n    \"order.created\",\n    \"order.failed\",\n    \"order.status_changed\"\n  ],\n  \"secret\": \"whsec_your_secret_here\",\n  \"description\": \"Cata order notifications\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Tenant-ID", "string")
	req.Header.Add("X-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/webhooks/subscriptions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = 'string'
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://your-system.com/webhooks/pos\",\n  \"events\": [\n    \"order.created\",\n    \"order.failed\",\n    \"order.status_changed\"\n  ],\n  \"secret\": \"whsec_your_secret_here\",\n  \"description\": \"Cata order notifications\"\n}"

response = http.request(request)
puts response.read_body
```

```java api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/webhooks/subscriptions")
  .header("X-Tenant-ID", "string")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://your-system.com/webhooks/pos\",\n  \"events\": [\n    \"order.created\",\n    \"order.failed\",\n    \"order.status_changed\"\n  ],\n  \"secret\": \"whsec_your_secret_here\",\n  \"description\": \"Cata order notifications\"\n}")
  .asString();
```

```php api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:8080/api/v1/webhooks/subscriptions', [
  'body' => '{
  "url": "https://your-system.com/webhooks/pos",
  "events": [
    "order.created",
    "order.failed",
    "order.status_changed"
  ],
  "secret": "whsec_your_secret_here",
  "description": "Cata order notifications"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
    'X-Tenant-ID' => 'string',
  ],
]);

echo $response->getBody();
```

```csharp api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/webhooks/subscriptions");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Tenant-ID", "string");
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://your-system.com/webhooks/pos\",\n  \"events\": [\n    \"order.created\",\n    \"order.failed\",\n    \"order.status_changed\"\n  ],\n  \"secret\": \"whsec_your_secret_here\",\n  \"description\": \"Cata order notifications\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift api_v1_webhooks_subscriptions_[Not Implemented] Register webhook_example
import Foundation

let headers = [
  "X-Tenant-ID": "string",
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "url": "https://your-system.com/webhooks/pos",
  "events": ["order.created", "order.failed", "order.status_changed"],
  "secret": "whsec_your_secret_here",
  "description": "Cata order notifications"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/webhooks/subscriptions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```