KosmoKrator

productivity

Dub Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Dub KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.dub.*. Use lua_read_doc("integrations.dub") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Dub workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.dub.analytics_retrieve({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("dub"))' --json
kosmo integrations:lua --eval 'print(docs.read("dub.analytics_retrieve"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local dub = app.integrations.dub
local result = dub.analytics_retrieve({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.dub, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.dub.default.* or app.integrations.dub.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Dub, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Dub Integration

Namespace: app.integrations.dub.

This integration follows the official Dub API surface exposed by the official PHP SDK. Use top-level snake_case arguments for path parameters, query for query-string filters, and payload for JSON request bodies.

dub_analytics_retrieve

Retrieve analytics for a link, a domain, or the authenticated workspace.

  • Method/path: GET /analytics
  • Parameters: none
  • Query: query object
  • Body: none

dub_bounties_approve_submission

Approve a bounty submission

  • Method/path: POST /bounties/{bountyId}/submissions/{submissionId}/approve
  • Parameters: bounty_id, submission_id
  • Query: query object
  • Body: payload object

dub_bounties_list_submissions

List bounty submissions

  • Method/path: GET /bounties/{bountyId}/submissions
  • Parameters: bounty_id
  • Query: query object
  • Body: none

dub_bounties_reject_submission

Reject a bounty submission

  • Method/path: POST /bounties/{bountyId}/submissions/{submissionId}/reject
  • Parameters: bounty_id, submission_id
  • Query: query object
  • Body: payload object

dub_commissions_list

List all commissions

  • Method/path: GET /commissions
  • Parameters: none
  • Query: query object
  • Body: none

dub_commissions_update

Update a commission

  • Method/path: PATCH /commissions/{id}
  • Parameters: id
  • Query: query object
  • Body: payload object

dub_commissions_update_many

Bulk update commissions

  • Method/path: PATCH /commissions/bulk
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_customers_delete

Delete a customer

  • Method/path: DELETE /customers/{id}
  • Parameters: id
  • Query: query object
  • Body: none

dub_customers_get

Retrieve a customer

  • Method/path: GET /customers/{id}
  • Parameters: id
  • Query: query object
  • Body: none

dub_customers_list

List all customers

  • Method/path: GET /customers
  • Parameters: none
  • Query: query object
  • Body: none

dub_customers_update

Update a customer

  • Method/path: PATCH /customers/{id}
  • Parameters: id
  • Query: query object
  • Body: payload object

dub_domains_check_status

Check the availability of one or more domains

  • Method/path: GET /domains/status
  • Parameters: none
  • Query: query object
  • Body: none

dub_domains_create

Create a domain

  • Method/path: POST /domains
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_domains_delete

Delete a domain

  • Method/path: DELETE /domains/{slug}
  • Parameters: slug
  • Query: query object
  • Body: none

dub_domains_list

List all domains

  • Method/path: GET /domains
  • Parameters: none
  • Query: query object
  • Body: none

dub_domains_register

Register a domain

  • Method/path: POST /domains/register
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_domains_update

Update a domain

  • Method/path: PATCH /domains/{slug}
  • Parameters: slug
  • Query: query object
  • Body: payload object

dub_embed_tokens_referrals

Create a referrals embed token

  • Method/path: POST /tokens/embed/referrals
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_events_list

List all events

  • Method/path: GET /events
  • Parameters: none
  • Query: query object
  • Body: none

dub_folders_create

Create a folder

  • Method/path: POST /folders
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_folders_delete

Delete a folder

  • Method/path: DELETE /folders/{id}
  • Parameters: id
  • Query: query object
  • Body: none

dub_folders_list

List all folders

  • Method/path: GET /folders
  • Parameters: none
  • Query: query object
  • Body: none

dub_folders_update

Update a folder

  • Method/path: PATCH /folders/{id}
  • Parameters: id
  • Query: query object
  • Body: payload object

Retrieve links count

  • Method/path: GET /links/count
  • Parameters: none
  • Query: query object
  • Body: none

Create a link

  • Method/path: POST /links
  • Parameters: none
  • Query: query object
  • Body: payload object

Bulk create links

  • Method/path: POST /links/bulk
  • Parameters: none
  • Query: query object
  • Body: payload object

Delete a link

  • Method/path: DELETE /links/{linkId}
  • Parameters: link_id
  • Query: query object
  • Body: none

Bulk delete links

  • Method/path: DELETE /links/bulk
  • Parameters: none
  • Query: query object
  • Body: none

Retrieve a link

  • Method/path: GET /links/info
  • Parameters: none
  • Query: query object
  • Body: none

List all links

  • Method/path: GET /links
  • Parameters: none
  • Query: query object
  • Body: none

Update a link

  • Method/path: PATCH /links/{linkId}
  • Parameters: link_id
  • Query: query object
  • Body: payload object

Bulk update links

  • Method/path: PATCH /links/bulk
  • Parameters: none
  • Query: query object
  • Body: payload object

Upsert a link

  • Method/path: PUT /links/upsert
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_partner_applications_approve

Approve a partner application

  • Method/path: POST /partners/applications/approve
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_partner_applications_list

List all pending partner applications

  • Method/path: GET /partners/applications
  • Parameters: none
  • Query: query object
  • Body: none

dub_partner_applications_reject

Reject a partner application

  • Method/path: POST /partners/applications/reject
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_partners_analytics

Retrieve analytics for a partner

  • Method/path: GET /partners/analytics
  • Parameters: none
  • Query: query object
  • Body: none

dub_partners_ban

Ban a partner

  • Method/path: POST /partners/ban
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_partners_create

Create or update a partner

  • Method/path: POST /partners
  • Parameters: none
  • Query: query object
  • Body: payload object

Create a link for a partner

  • Method/path: POST /partners/links
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_partners_deactivate

Deactivate a partner

  • Method/path: POST /partners/deactivate
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_partners_list

List all partners

  • Method/path: GET /partners
  • Parameters: none
  • Query: query object
  • Body: none

Retrieve a partner’s links.

  • Method/path: GET /partners/links
  • Parameters: none
  • Query: query object
  • Body: none

Upsert a link for a partner

  • Method/path: PUT /partners/links/upsert
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_payouts_list

List all payouts

  • Method/path: GET /payouts
  • Parameters: none
  • Query: query object
  • Body: none

dub_qr_codes_get

Retrieve a QR code

  • Method/path: GET /qr
  • Parameters: none
  • Query: query object
  • Body: none

dub_tags_create

Create a tag

  • Method/path: POST /tags
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_tags_delete

Delete a tag

  • Method/path: DELETE /tags/{id}
  • Parameters: id
  • Query: query object
  • Body: none

dub_tags_list

List all tags

  • Method/path: GET /tags
  • Parameters: none
  • Query: query object
  • Body: none

dub_tags_update

Update a tag

  • Method/path: PATCH /tags/{id}
  • Parameters: id
  • Query: query object
  • Body: payload object

dub_track_lead

Track a lead

  • Method/path: POST /track/lead
  • Parameters: none
  • Query: query object
  • Body: payload object

dub_track_sale

Track a sale

  • Method/path: POST /track/sale
  • Parameters: none
  • Query: query object
  • Body: payload object

Examples

local links = app.integrations.dub.links_list({ query = { pageSize = 10 } })
local created = app.integrations.dub.links_create({ payload = { url = 'https://example.test' } })
Raw agent markdown 
# Dub Integration

Namespace: `app.integrations.dub`.

This integration follows the official Dub API surface exposed by the official PHP SDK. Use top-level snake_case arguments for path parameters, `query` for query-string filters, and `payload` for JSON request bodies.

### dub_analytics_retrieve
Retrieve analytics for a link, a domain, or the authenticated workspace.

- Method/path: `GET /analytics`
- Parameters: none
- Query: `query` object
- Body: none

### dub_bounties_approve_submission
Approve a bounty submission

- Method/path: `POST /bounties/{bountyId}/submissions/{submissionId}/approve`
- Parameters: `bounty_id`, `submission_id`
- Query: `query` object
- Body: `payload` object

### dub_bounties_list_submissions
List bounty submissions

- Method/path: `GET /bounties/{bountyId}/submissions`
- Parameters: `bounty_id`
- Query: `query` object
- Body: none

### dub_bounties_reject_submission
Reject a bounty submission

- Method/path: `POST /bounties/{bountyId}/submissions/{submissionId}/reject`
- Parameters: `bounty_id`, `submission_id`
- Query: `query` object
- Body: `payload` object

### dub_commissions_list
List all commissions

- Method/path: `GET /commissions`
- Parameters: none
- Query: `query` object
- Body: none

### dub_commissions_update
Update a commission

- Method/path: `PATCH /commissions/{id}`
- Parameters: `id`
- Query: `query` object
- Body: `payload` object

### dub_commissions_update_many
Bulk update commissions

- Method/path: `PATCH /commissions/bulk`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_customers_delete
Delete a customer

- Method/path: `DELETE /customers/{id}`
- Parameters: `id`
- Query: `query` object
- Body: none

### dub_customers_get
Retrieve a customer

- Method/path: `GET /customers/{id}`
- Parameters: `id`
- Query: `query` object
- Body: none

### dub_customers_list
List all customers

- Method/path: `GET /customers`
- Parameters: none
- Query: `query` object
- Body: none

### dub_customers_update
Update a customer

- Method/path: `PATCH /customers/{id}`
- Parameters: `id`
- Query: `query` object
- Body: `payload` object

### dub_domains_check_status
Check the availability of one or more domains

- Method/path: `GET /domains/status`
- Parameters: none
- Query: `query` object
- Body: none

### dub_domains_create
Create a domain

- Method/path: `POST /domains`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_domains_delete
Delete a domain

- Method/path: `DELETE /domains/{slug}`
- Parameters: `slug`
- Query: `query` object
- Body: none

### dub_domains_list
List all domains

- Method/path: `GET /domains`
- Parameters: none
- Query: `query` object
- Body: none

### dub_domains_register
Register a domain

- Method/path: `POST /domains/register`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_domains_update
Update a domain

- Method/path: `PATCH /domains/{slug}`
- Parameters: `slug`
- Query: `query` object
- Body: `payload` object

### dub_embed_tokens_referrals
Create a referrals embed token

- Method/path: `POST /tokens/embed/referrals`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_events_list
List all events

- Method/path: `GET /events`
- Parameters: none
- Query: `query` object
- Body: none

### dub_folders_create
Create a folder

- Method/path: `POST /folders`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_folders_delete
Delete a folder

- Method/path: `DELETE /folders/{id}`
- Parameters: `id`
- Query: `query` object
- Body: none

### dub_folders_list
List all folders

- Method/path: `GET /folders`
- Parameters: none
- Query: `query` object
- Body: none

### dub_folders_update
Update a folder

- Method/path: `PATCH /folders/{id}`
- Parameters: `id`
- Query: `query` object
- Body: `payload` object

### dub_links_count
Retrieve links count

- Method/path: `GET /links/count`
- Parameters: none
- Query: `query` object
- Body: none

### dub_links_create
Create a link

- Method/path: `POST /links`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_links_create_many
Bulk create links

- Method/path: `POST /links/bulk`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_links_delete
Delete a link

- Method/path: `DELETE /links/{linkId}`
- Parameters: `link_id`
- Query: `query` object
- Body: none

### dub_links_delete_many
Bulk delete links

- Method/path: `DELETE /links/bulk`
- Parameters: none
- Query: `query` object
- Body: none

### dub_links_get
Retrieve a link

- Method/path: `GET /links/info`
- Parameters: none
- Query: `query` object
- Body: none

### dub_links_list
List all links

- Method/path: `GET /links`
- Parameters: none
- Query: `query` object
- Body: none

### dub_links_update
Update a link

- Method/path: `PATCH /links/{linkId}`
- Parameters: `link_id`
- Query: `query` object
- Body: `payload` object

### dub_links_update_many
Bulk update links

- Method/path: `PATCH /links/bulk`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_links_upsert
Upsert a link

- Method/path: `PUT /links/upsert`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_partner_applications_approve
Approve a partner application

- Method/path: `POST /partners/applications/approve`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_partner_applications_list
List all pending partner applications

- Method/path: `GET /partners/applications`
- Parameters: none
- Query: `query` object
- Body: none

### dub_partner_applications_reject
Reject a partner application

- Method/path: `POST /partners/applications/reject`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_partners_analytics
Retrieve analytics for a partner

- Method/path: `GET /partners/analytics`
- Parameters: none
- Query: `query` object
- Body: none

### dub_partners_ban
Ban a partner

- Method/path: `POST /partners/ban`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_partners_create
Create or update a partner

- Method/path: `POST /partners`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_partners_create_link
Create a link for a partner

- Method/path: `POST /partners/links`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_partners_deactivate
Deactivate a partner

- Method/path: `POST /partners/deactivate`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_partners_list
List all partners

- Method/path: `GET /partners`
- Parameters: none
- Query: `query` object
- Body: none

### dub_partners_retrieve_links
Retrieve a partner's links.

- Method/path: `GET /partners/links`
- Parameters: none
- Query: `query` object
- Body: none

### dub_partners_upsert_link
Upsert a link for a partner

- Method/path: `PUT /partners/links/upsert`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_payouts_list
List all payouts

- Method/path: `GET /payouts`
- Parameters: none
- Query: `query` object
- Body: none

### dub_qr_codes_get
Retrieve a QR code

- Method/path: `GET /qr`
- Parameters: none
- Query: `query` object
- Body: none

### dub_tags_create
Create a tag

- Method/path: `POST /tags`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_tags_delete
Delete a tag

- Method/path: `DELETE /tags/{id}`
- Parameters: `id`
- Query: `query` object
- Body: none

### dub_tags_list
List all tags

- Method/path: `GET /tags`
- Parameters: none
- Query: `query` object
- Body: none

### dub_tags_update
Update a tag

- Method/path: `PATCH /tags/{id}`
- Parameters: `id`
- Query: `query` object
- Body: `payload` object

### dub_track_lead
Track a lead

- Method/path: `POST /track/lead`
- Parameters: none
- Query: `query` object
- Body: `payload` object

### dub_track_sale
Track a sale

- Method/path: `POST /track/sale`
- Parameters: none
- Query: `query` object
- Body: `payload` object

## Examples

```lua
local links = app.integrations.dub.links_list({ query = { pageSize = 10 } })
local created = app.integrations.dub.links_create({ payload = { url = 'https://example.test' } })
```
Metadata-derived Lua example 
local result = app.integrations.dub.analytics_retrieve({})
print(result)

Functions

analytics_retrieve Read

Retrieve analytics for a link, a domain, or the authenticated workspace.

Lua path
app.integrations.dub.analytics_retrieve
Full name
dub.dub_analytics_retrieve
ParameterTypeRequiredDescription
No parameters.
bounties_approve_submission Write

Approve a bounty submission

Lua path
app.integrations.dub.bounties_approve_submission
Full name
dub.dub_bounties_approve_submission
ParameterTypeRequiredDescription
No parameters.
bounties_list_submissions Read

List bounty submissions

Lua path
app.integrations.dub.bounties_list_submissions
Full name
dub.dub_bounties_list_submissions
ParameterTypeRequiredDescription
No parameters.
bounties_reject_submission Write

Reject a bounty submission

Lua path
app.integrations.dub.bounties_reject_submission
Full name
dub.dub_bounties_reject_submission
ParameterTypeRequiredDescription
No parameters.
commissions_list Read

List all commissions

Lua path
app.integrations.dub.commissions_list
Full name
dub.dub_commissions_list
ParameterTypeRequiredDescription
No parameters.
commissions_update Write

Update a commission

Lua path
app.integrations.dub.commissions_update
Full name
dub.dub_commissions_update
ParameterTypeRequiredDescription
No parameters.
commissions_update_many Write

Bulk update commissions

Lua path
app.integrations.dub.commissions_update_many
Full name
dub.dub_commissions_update_many
ParameterTypeRequiredDescription
No parameters.
customers_delete Write

Delete a customer

Lua path
app.integrations.dub.customers_delete
Full name
dub.dub_customers_delete
ParameterTypeRequiredDescription
No parameters.
customers_get Read

Retrieve a customer

Lua path
app.integrations.dub.customers_get
Full name
dub.dub_customers_get
ParameterTypeRequiredDescription
No parameters.
customers_list Read

List all customers

Lua path
app.integrations.dub.customers_list
Full name
dub.dub_customers_list
ParameterTypeRequiredDescription
No parameters.
customers_update Write

Update a customer

Lua path
app.integrations.dub.customers_update
Full name
dub.dub_customers_update
ParameterTypeRequiredDescription
No parameters.
domains_check_status Read

Check the availability of one or more domains

Lua path
app.integrations.dub.domains_check_status
Full name
dub.dub_domains_check_status
ParameterTypeRequiredDescription
No parameters.
domains_create Write

Create a domain

Lua path
app.integrations.dub.domains_create
Full name
dub.dub_domains_create
ParameterTypeRequiredDescription
No parameters.
domains_delete Write

Delete a domain

Lua path
app.integrations.dub.domains_delete
Full name
dub.dub_domains_delete
ParameterTypeRequiredDescription
No parameters.
domains_list Read

List all domains

Lua path
app.integrations.dub.domains_list
Full name
dub.dub_domains_list
ParameterTypeRequiredDescription
No parameters.
domains_register Write

Register a domain

Lua path
app.integrations.dub.domains_register
Full name
dub.dub_domains_register
ParameterTypeRequiredDescription
No parameters.
domains_update Write

Update a domain

Lua path
app.integrations.dub.domains_update
Full name
dub.dub_domains_update
ParameterTypeRequiredDescription
No parameters.
embed_tokens_referrals Write

Create a referrals embed token

Lua path
app.integrations.dub.embed_tokens_referrals
Full name
dub.dub_embed_tokens_referrals
ParameterTypeRequiredDescription
No parameters.
events_list Read

List all events

Lua path
app.integrations.dub.events_list
Full name
dub.dub_events_list
ParameterTypeRequiredDescription
No parameters.
folders_create Write

Create a folder

Lua path
app.integrations.dub.folders_create
Full name
dub.dub_folders_create
ParameterTypeRequiredDescription
No parameters.
folders_delete Write

Delete a folder

Lua path
app.integrations.dub.folders_delete
Full name
dub.dub_folders_delete
ParameterTypeRequiredDescription
No parameters.
folders_list Read

List all folders

Lua path
app.integrations.dub.folders_list
Full name
dub.dub_folders_list
ParameterTypeRequiredDescription
No parameters.
folders_update Write

Update a folder

Lua path
app.integrations.dub.folders_update
Full name
dub.dub_folders_update
ParameterTypeRequiredDescription
No parameters.
partner_applications_approve Write

Approve a partner application

Lua path
app.integrations.dub.partner_applications_approve
Full name
dub.dub_partner_applications_approve
ParameterTypeRequiredDescription
No parameters.
partner_applications_list Read

List all pending partner applications

Lua path
app.integrations.dub.partner_applications_list
Full name
dub.dub_partner_applications_list
ParameterTypeRequiredDescription
No parameters.
partner_applications_reject Write

Reject a partner application

Lua path
app.integrations.dub.partner_applications_reject
Full name
dub.dub_partner_applications_reject
ParameterTypeRequiredDescription
No parameters.
partners_analytics Read

Retrieve analytics for a partner

Lua path
app.integrations.dub.partners_analytics
Full name
dub.dub_partners_analytics
ParameterTypeRequiredDescription
No parameters.
partners_ban Write

Ban a partner

Lua path
app.integrations.dub.partners_ban
Full name
dub.dub_partners_ban
ParameterTypeRequiredDescription
No parameters.
partners_create Write

Create or update a partner

Lua path
app.integrations.dub.partners_create
Full name
dub.dub_partners_create
ParameterTypeRequiredDescription
No parameters.
partners_deactivate Write

Deactivate a partner

Lua path
app.integrations.dub.partners_deactivate
Full name
dub.dub_partners_deactivate
ParameterTypeRequiredDescription
No parameters.
partners_list Read

List all partners

Lua path
app.integrations.dub.partners_list
Full name
dub.dub_partners_list
ParameterTypeRequiredDescription
No parameters.
payouts_list Read

List all payouts

Lua path
app.integrations.dub.payouts_list
Full name
dub.dub_payouts_list
ParameterTypeRequiredDescription
No parameters.
qr_codes_get Read

Retrieve a QR code

Lua path
app.integrations.dub.qr_codes_get
Full name
dub.dub_qr_codes_get
ParameterTypeRequiredDescription
No parameters.
tags_create Write

Create a tag

Lua path
app.integrations.dub.tags_create
Full name
dub.dub_tags_create
ParameterTypeRequiredDescription
No parameters.
tags_delete Write

Delete a tag

Lua path
app.integrations.dub.tags_delete
Full name
dub.dub_tags_delete
ParameterTypeRequiredDescription
No parameters.
tags_list Read

List all tags

Lua path
app.integrations.dub.tags_list
Full name
dub.dub_tags_list
ParameterTypeRequiredDescription
No parameters.
tags_update Write

Update a tag

Lua path
app.integrations.dub.tags_update
Full name
dub.dub_tags_update
ParameterTypeRequiredDescription
No parameters.
track_lead Write

Track a lead

Lua path
app.integrations.dub.track_lead
Full name
dub.dub_track_lead
ParameterTypeRequiredDescription
No parameters.
track_sale Write

Track a sale

Lua path
app.integrations.dub.track_sale
Full name
dub.dub_track_sale
ParameterTypeRequiredDescription
No parameters.