Set POS connection
set_pos_connectionCreate or update the organization's POS connection (requires the admin role; one per organization). Called with a connected app's token the app becomes its owner. endpoint: { url, secret?, includes? } creates — or on a later call edits — the connection's event channel; webhookEndpointId adopts an existing endpoint instead. Generated secrets (secret for Cluby → POS calls, endpointSecret for a created endpoint) are returned once, so show them to the user. Only the fields sent change.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "set_pos_connection"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Your product's name, as the organization sees it. | |
| orgId | No | Organization public id, the `id` field from list_orgs. Omit it when the API key reaches exactly one organization. | |
| secret | No | Signs Cluby's calls to your service — the article search — over their request line, the way events are signed. Generated when omitted and returned once; send your own to keep a copy. | |
| enabled | No | `false` pauses the connection and its channel. Your next PUT after reconnecting turns them back on. | |
| endpoint | No | The connection's event channel, the webhook endpoint that receives `smart_link.scanned`. Created with every include unless `includes` says otherwise; an endpoint created earlier keeps the includes it lists. `url` is required on the first call; later calls change only the fields sent. | |
| capabilities | No | What your POS can do with an action's answer. | |
| articleSearchUrl | No | Your article search, which Cluby calls live when a venue picks articles or looks at the ones it linked (the guide's "The article search"). Stored without being called; check it with POST …/pos-connection/test-article-search. Optional. | |
| webhookEndpointId | No | Instead of `endpoint`: use one of the organization's existing endpoints as the channel. |