[Not Implemented] Register webhook | Cata API

curl -X POST http://localhost:8080/api/v1/webhooks/subscriptions \
     -H "X-Tenant-ID: string" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "url": "https://your-system.com/webhooks/pos",
  "events": [
    "order.created",
    "order.failed",
    "order.status_changed"
  ],
  "secret": "whsec_your_secret_here",
  "description": "Cata order notifications"
}'

{
  "subscriptionId": "sub_01HXYZ123ABC",
  "url": "http://JXnWbUTbZc.tdgnmymztYvbOVjpeUFqitJJfe",
  "events": [
    "outlet.updated",
    "menu.failed"
  ],
  "description": "string",
  "status": "inactive",
  "tenantId": "string",
  "createdAt": "1996-10-19T23:33:17.965Z"
}

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.

> **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`.

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

eventslist of stringsRequired

secretstringRequired

descriptionstringRequired

Response

Created

urlstringformat: "uri"

eventslist of strings

statusstring

tenantIdstring

createdAtdatetime

descriptionstring

subscriptionIdstring

Errors

400

Bad Request Error

401

Unauthorized Error

Authentication

Headers

Request

Response

Errors