Skip to navigation
POS Integration Service APIAPIV1WebhooksSubscriptions

[Not Implemented] Register webhook

View as MarkdownOpen in Claude

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

Headers

X-Tenant-IDstringOptional
Tenant identifier

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
eventslist of stringsRequired
secretstringRequired
descriptionstringRequired

Response

Created
subscriptionIdstring
urlstringformat: "uri"
eventslist of strings
descriptionstring
statusstring
tenantIdstring
createdAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error