productivity
Campaign Monitor Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the Campaign Monitor KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.campaign_monitor.*.
Use lua_read_doc("integrations.campaign-monitor") 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
Campaign Monitor workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.campaign_monitor.get_current_user({}))' --json kosmo integrations:lua --eval 'print(docs.read("campaign-monitor"))' --json
kosmo integrations:lua --eval 'print(docs.read("campaign-monitor.get_current_user"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local campaign_monitor = app.integrations.campaign_monitor
local result = campaign_monitor.get_current_user({})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.campaign_monitor, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.campaign_monitor.default.* or app.integrations.campaign_monitor.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need Campaign Monitor, use the narrower 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.
Campaign Monitor Lua API Reference
Namespace: app.integrations.campaign-monitor
This integration targets Campaign Monitor API v3.3 at
https://api.createsend.com/api/v3.3. Most tools accept a params object for
query strings or a payload object for write requests. Write request fields use
Campaign Monitor’s documented PascalCase names.
Common Patterns
List clients:
local clients = app.integrations["campaign-monitor"].list_clients({})
List sent campaigns for a client:
local campaigns = app.integrations["campaign-monitor"].list_campaigns({
client_id = "client_test",
page = 1,
pagesize = 50
})
Add or update a subscriber:
local result = app.integrations["campaign-monitor"].add_subscriber({
list_id = "list_test",
EmailAddress = "reader@example.test",
Name = "Ada Reader",
Resubscribe = true,
ConsentToTrack = "Yes"
})
Send a transactional classic email:
local result = app.integrations["campaign-monitor"].send_classic_email({
clientID = "client_test",
payload = {
Subject = "Receipt",
From = "Billing <billing@example.test>",
To = { "reader@example.test" },
Html = "<p>Thanks</p>",
Text = "Thanks",
ConsentToTrack = "No"
}
})
Resource Coverage
Tools cover:
- Account setup:
get_current_user,list_clients,create_client,get_client,update_client,delete_client,list_countries,list_time_zones,get_system_date - Client resources:
list_lists,list_lists_for_email,list_client_segments,list_client_templates,list_client_suppression_list,unsuppress_email,list_client_tags,list_campaigns,list_draft_campaigns,list_scheduled_campaigns - Campaigns and reports:
create_campaign,get_campaign,send_campaign,unschedule_campaign,delete_campaign,get_campaign_summary,get_campaign_email_client_usage,get_campaign_lists_and_segments,list_campaign_recipients,list_campaign_bounces,list_campaign_opens,list_campaign_clicks,list_campaign_unsubscribes,list_campaign_spam_complaints - Lists and custom fields:
create_list,get_list,update_list,delete_list,get_list_stats,list_custom_fields,create_custom_field,update_custom_field,delete_custom_field - Subscribers:
list_subscribers,list_unconfirmed_subscribers,list_unsubscribed_subscribers,list_deleted_subscribers,list_bounced_subscribers,add_subscriber,import_subscribers,get_subscriber,update_subscriber,delete_subscriber,unsubscribe_subscriber,get_subscriber_history - Segments:
create_segment,get_segment,update_segment,delete_segment,list_segment_subscribers - Webhooks:
list_webhooks,create_webhook,get_webhook,test_webhook,activate_webhook,deactivate_webhook,delete_webhook - Transactional:
list_smart_emails,get_smart_email,send_smart_email,send_classic_email,list_classic_email_groups,get_transactional_statistics,list_transactional_messages,get_transactional_message,resend_transactional_message
Raw API Helpers
Use raw helpers for documented endpoints not yet wrapped:
local result = app.integrations["campaign-monitor"].api_get({
path = "/clients.json"
})
The path must be relative. Absolute URLs and parent-directory paths are
rejected.
Multi-Account Usage
app.integrations["campaign-monitor"].list_clients({})
app.integrations["campaign-monitor"].default.list_clients({})
app.integrations["campaign-monitor"].work.list_clients({})Raw agent markdown
# Campaign Monitor Lua API Reference
Namespace: `app.integrations.campaign-monitor`
This integration targets Campaign Monitor API v3.3 at
`https://api.createsend.com/api/v3.3`. Most tools accept a `params` object for
query strings or a `payload` object for write requests. Write request fields use
Campaign Monitor's documented PascalCase names.
## Common Patterns
List clients:
```lua
local clients = app.integrations["campaign-monitor"].list_clients({})
```
List sent campaigns for a client:
```lua
local campaigns = app.integrations["campaign-monitor"].list_campaigns({
client_id = "client_test",
page = 1,
pagesize = 50
})
```
Add or update a subscriber:
```lua
local result = app.integrations["campaign-monitor"].add_subscriber({
list_id = "list_test",
EmailAddress = "reader@example.test",
Name = "Ada Reader",
Resubscribe = true,
ConsentToTrack = "Yes"
})
```
Send a transactional classic email:
```lua
local result = app.integrations["campaign-monitor"].send_classic_email({
clientID = "client_test",
payload = {
Subject = "Receipt",
From = "Billing <billing@example.test>",
To = { "reader@example.test" },
Html = "<p>Thanks</p>",
Text = "Thanks",
ConsentToTrack = "No"
}
})
```
## Resource Coverage
Tools cover:
- Account setup: `get_current_user`, `list_clients`, `create_client`, `get_client`, `update_client`, `delete_client`, `list_countries`, `list_time_zones`, `get_system_date`
- Client resources: `list_lists`, `list_lists_for_email`, `list_client_segments`, `list_client_templates`, `list_client_suppression_list`, `unsuppress_email`, `list_client_tags`, `list_campaigns`, `list_draft_campaigns`, `list_scheduled_campaigns`
- Campaigns and reports: `create_campaign`, `get_campaign`, `send_campaign`, `unschedule_campaign`, `delete_campaign`, `get_campaign_summary`, `get_campaign_email_client_usage`, `get_campaign_lists_and_segments`, `list_campaign_recipients`, `list_campaign_bounces`, `list_campaign_opens`, `list_campaign_clicks`, `list_campaign_unsubscribes`, `list_campaign_spam_complaints`
- Lists and custom fields: `create_list`, `get_list`, `update_list`, `delete_list`, `get_list_stats`, `list_custom_fields`, `create_custom_field`, `update_custom_field`, `delete_custom_field`
- Subscribers: `list_subscribers`, `list_unconfirmed_subscribers`, `list_unsubscribed_subscribers`, `list_deleted_subscribers`, `list_bounced_subscribers`, `add_subscriber`, `import_subscribers`, `get_subscriber`, `update_subscriber`, `delete_subscriber`, `unsubscribe_subscriber`, `get_subscriber_history`
- Segments: `create_segment`, `get_segment`, `update_segment`, `delete_segment`, `list_segment_subscribers`
- Webhooks: `list_webhooks`, `create_webhook`, `get_webhook`, `test_webhook`, `activate_webhook`, `deactivate_webhook`, `delete_webhook`
- Transactional: `list_smart_emails`, `get_smart_email`, `send_smart_email`, `send_classic_email`, `list_classic_email_groups`, `get_transactional_statistics`, `list_transactional_messages`, `get_transactional_message`, `resend_transactional_message`
## Raw API Helpers
Use raw helpers for documented endpoints not yet wrapped:
```lua
local result = app.integrations["campaign-monitor"].api_get({
path = "/clients.json"
})
```
The `path` must be relative. Absolute URLs and parent-directory paths are
rejected.
## Multi-Account Usage
```lua
app.integrations["campaign-monitor"].list_clients({})
app.integrations["campaign-monitor"].default.list_clients({})
app.integrations["campaign-monitor"].work.list_clients({})
``` local result = app.integrations.campaign_monitor.get_current_user({})
print(result) Functions
get_current_user Read
Get the account primary contact.
- Lua path
app.integrations.campaign_monitor.get_current_user- Full name
campaign-monitor.campaignmonitor_get_current_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_clients Read
List clients visible to the account.
- Lua path
app.integrations.campaign_monitor.list_clients- Full name
campaign-monitor.campaignmonitor_list_clients
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_client Write
Create a client in the account.
- Lua path
app.integrations.campaign_monitor.create_client- Full name
campaign-monitor.campaignmonitor_create_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_client Read
Get client details.
- Lua path
app.integrations.campaign_monitor.get_client- Full name
campaign-monitor.campaignmonitor_get_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_client Write
Update client details.
- Lua path
app.integrations.campaign_monitor.update_client- Full name
campaign-monitor.campaignmonitor_update_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_client Write
Delete a client.
- Lua path
app.integrations.campaign_monitor.delete_client- Full name
campaign-monitor.campaignmonitor_delete_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_countries Read
List supported countries for client setup.
- Lua path
app.integrations.campaign_monitor.list_countries- Full name
campaign-monitor.campaignmonitor_list_countries
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_time_zones Read
List supported time zones for client setup.
- Lua path
app.integrations.campaign_monitor.list_time_zones- Full name
campaign-monitor.campaignmonitor_list_time_zones
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_system_date Read
Get the current Campaign Monitor system date.
- Lua path
app.integrations.campaign_monitor.get_system_date- Full name
campaign-monitor.campaignmonitor_get_system_date
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_subscriber_lists Read
List subscriber lists for a client.
- Lua path
app.integrations.campaign_monitor.list_subscriber_lists- Full name
campaign-monitor.campaignmonitor_list_lists
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_lists_email Read
List subscriber lists a specific email belongs to.
- Lua path
app.integrations.campaign_monitor.list_lists_email- Full name
campaign-monitor.campaignmonitor_list_lists_for_email
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_client_segments Read
List segments for a client.
- Lua path
app.integrations.campaign_monitor.list_client_segments- Full name
campaign-monitor.campaignmonitor_list_client_segments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_client_templates Read
List templates for a client.
- Lua path
app.integrations.campaign_monitor.list_client_templates- Full name
campaign-monitor.campaignmonitor_list_client_templates
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_client_suppression_list Read
List suppressed email addresses for a client.
- Lua path
app.integrations.campaign_monitor.list_client_suppression_list- Full name
campaign-monitor.campaignmonitor_list_client_suppression_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
unsuppress_email Write
Remove an email address from a client suppression list.
- Lua path
app.integrations.campaign_monitor.unsuppress_email- Full name
campaign-monitor.campaignmonitor_unsuppress_email
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_client_tags Read
List campaign tags for a client.
- Lua path
app.integrations.campaign_monitor.list_client_tags- Full name
campaign-monitor.campaignmonitor_list_client_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list Read
List sent campaigns for a client.
- Lua path
app.integrations.campaign_monitor.list- Full name
campaign-monitor.campaignmonitor_list_campaigns
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_draft Read
List draft campaigns for a client.
- Lua path
app.integrations.campaign_monitor.list_draft- Full name
campaign-monitor.campaignmonitor_list_draft_campaigns
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_scheduled Read
List scheduled campaigns for a client.
- Lua path
app.integrations.campaign_monitor.list_scheduled- Full name
campaign-monitor.campaignmonitor_list_scheduled_campaigns
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create Write
Create a draft campaign for a client.
- Lua path
app.integrations.campaign_monitor.create- Full name
campaign-monitor.campaignmonitor_create_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get Read
Get campaign details.
- Lua path
app.integrations.campaign_monitor.get- Full name
campaign-monitor.campaignmonitor_get_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete Write
Delete a draft or scheduled campaign.
- Lua path
app.integrations.campaign_monitor.delete- Full name
campaign-monitor.campaignmonitor_delete_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
send Write
Send or schedule a campaign.
- Lua path
app.integrations.campaign_monitor.send- Full name
campaign-monitor.campaignmonitor_send_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
unschedule Write
Unschedule a campaign and move it back to drafts.
- Lua path
app.integrations.campaign_monitor.unschedule- Full name
campaign-monitor.campaignmonitor_unschedule_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_summary Read
Get campaign summary reporting.
- Lua path
app.integrations.campaign_monitor.get_summary- Full name
campaign-monitor.campaignmonitor_get_campaign_summary
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_email_client_usage Read
List email clients used to open a campaign.
- Lua path
app.integrations.campaign_monitor.get_email_client_usage- Full name
campaign-monitor.campaignmonitor_get_campaign_email_client_usage
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_lists_and_segments Read
List campaign recipient lists and segments.
- Lua path
app.integrations.campaign_monitor.get_lists_and_segments- Full name
campaign-monitor.campaignmonitor_get_campaign_lists_and_segments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_recipients Read
List campaign recipients.
- Lua path
app.integrations.campaign_monitor.list_recipients- Full name
campaign-monitor.campaignmonitor_list_campaign_recipients
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_bounces Read
List campaign bounces.
- Lua path
app.integrations.campaign_monitor.list_bounces- Full name
campaign-monitor.campaignmonitor_list_campaign_bounces
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_opens Read
List campaign opens.
- Lua path
app.integrations.campaign_monitor.list_opens- Full name
campaign-monitor.campaignmonitor_list_campaign_opens
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_clicks Read
List campaign clicks.
- Lua path
app.integrations.campaign_monitor.list_clicks- Full name
campaign-monitor.campaignmonitor_list_campaign_clicks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_unsubscribes Read
List campaign unsubscribes.
- Lua path
app.integrations.campaign_monitor.list_unsubscribes- Full name
campaign-monitor.campaignmonitor_list_campaign_unsubscribes
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_spam_complaints Read
List campaign spam complaints.
- Lua path
app.integrations.campaign_monitor.list_spam_complaints- Full name
campaign-monitor.campaignmonitor_list_campaign_spam_complaints
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_list Write
Create a subscriber list for a client.
- Lua path
app.integrations.campaign_monitor.create_list- Full name
campaign-monitor.campaignmonitor_create_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_list Read
Get subscriber list details.
- Lua path
app.integrations.campaign_monitor.get_list- Full name
campaign-monitor.campaignmonitor_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_list Write
Update a subscriber list.
- Lua path
app.integrations.campaign_monitor.update_list- Full name
campaign-monitor.campaignmonitor_update_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_list Write
Delete a subscriber list.
- Lua path
app.integrations.campaign_monitor.delete_list- Full name
campaign-monitor.campaignmonitor_delete_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_list_stats Read
Get subscriber list statistics.
- Lua path
app.integrations.campaign_monitor.get_list_stats- Full name
campaign-monitor.campaignmonitor_get_list_stats
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_fields Read
List custom fields for a subscriber list.
- Lua path
app.integrations.campaign_monitor.list_custom_fields- Full name
campaign-monitor.campaignmonitor_list_custom_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_custom_field Write
Create a custom field on a list.
- Lua path
app.integrations.campaign_monitor.create_custom_field- Full name
campaign-monitor.campaignmonitor_create_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_field Write
Update a custom field on a list.
- Lua path
app.integrations.campaign_monitor.update_custom_field- Full name
campaign-monitor.campaignmonitor_update_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_custom_field Write
Delete a custom field from a list.
- Lua path
app.integrations.campaign_monitor.delete_custom_field- Full name
campaign-monitor.campaignmonitor_delete_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_subscribers Read
List active subscribers on a list.
- Lua path
app.integrations.campaign_monitor.list_subscribers- Full name
campaign-monitor.campaignmonitor_list_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_unconfirmed_subscribers Read
List unconfirmed subscribers on a list.
- Lua path
app.integrations.campaign_monitor.list_unconfirmed_subscribers- Full name
campaign-monitor.campaignmonitor_list_unconfirmed_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_unsubscribed_subscribers Read
List unsubscribed subscribers on a list.
- Lua path
app.integrations.campaign_monitor.list_unsubscribed_subscribers- Full name
campaign-monitor.campaignmonitor_list_unsubscribed_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_deleted_subscribers Read
List deleted subscribers on a list.
- Lua path
app.integrations.campaign_monitor.list_deleted_subscribers- Full name
campaign-monitor.campaignmonitor_list_deleted_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_bounced_subscribers Read
List bounced subscribers on a list.
- Lua path
app.integrations.campaign_monitor.list_bounced_subscribers- Full name
campaign-monitor.campaignmonitor_list_bounced_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
add_subscriber Write
Add or update a subscriber on a list.
- Lua path
app.integrations.campaign_monitor.add_subscriber- Full name
campaign-monitor.campaignmonitor_add_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
import_subscribers Write
Import many subscribers into a list.
- Lua path
app.integrations.campaign_monitor.import_subscribers- Full name
campaign-monitor.campaignmonitor_import_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_subscriber Read
Get subscriber details by email address.
- Lua path
app.integrations.campaign_monitor.get_subscriber- Full name
campaign-monitor.campaignmonitor_get_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_subscriber Write
Update subscriber details by email address.
- Lua path
app.integrations.campaign_monitor.update_subscriber- Full name
campaign-monitor.campaignmonitor_update_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_subscriber Write
Delete a subscriber from a list.
- Lua path
app.integrations.campaign_monitor.delete_subscriber- Full name
campaign-monitor.campaignmonitor_delete_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
unsubscribe_subscriber Write
Unsubscribe an email address from a list.
- Lua path
app.integrations.campaign_monitor.unsubscribe_subscriber- Full name
campaign-monitor.campaignmonitor_unsubscribe_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_subscriber_history Read
Get subscriber history by email address.
- Lua path
app.integrations.campaign_monitor.get_subscriber_history- Full name
campaign-monitor.campaignmonitor_get_subscriber_history
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_segment Write
Create a list segment.
- Lua path
app.integrations.campaign_monitor.create_segment- Full name
campaign-monitor.campaignmonitor_create_segment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_segment Read
Get segment details.
- Lua path
app.integrations.campaign_monitor.get_segment- Full name
campaign-monitor.campaignmonitor_get_segment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_segment Write
Update a segment.
- Lua path
app.integrations.campaign_monitor.update_segment- Full name
campaign-monitor.campaignmonitor_update_segment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_segment Write
Delete a segment.
- Lua path
app.integrations.campaign_monitor.delete_segment- Full name
campaign-monitor.campaignmonitor_delete_segment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_segment_subscribers Read
List active subscribers in a segment.
- Lua path
app.integrations.campaign_monitor.list_segment_subscribers- Full name
campaign-monitor.campaignmonitor_list_segment_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_webhooks Read
List webhooks for a subscriber list.
- Lua path
app.integrations.campaign_monitor.list_webhooks- Full name
campaign-monitor.campaignmonitor_list_webhooks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_webhook Write
Create a webhook for a subscriber list.
- Lua path
app.integrations.campaign_monitor.create_webhook- Full name
campaign-monitor.campaignmonitor_create_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_webhook Read
Get a list webhook.
- Lua path
app.integrations.campaign_monitor.get_webhook- Full name
campaign-monitor.campaignmonitor_get_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
test_webhook Write
Send a test payload to a webhook.
- Lua path
app.integrations.campaign_monitor.test_webhook- Full name
campaign-monitor.campaignmonitor_test_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
activate_webhook Write
Activate a list webhook.
- Lua path
app.integrations.campaign_monitor.activate_webhook- Full name
campaign-monitor.campaignmonitor_activate_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
deactivate_webhook Write
Deactivate a list webhook.
- Lua path
app.integrations.campaign_monitor.deactivate_webhook- Full name
campaign-monitor.campaignmonitor_deactivate_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_webhook Write
Delete a list webhook.
- Lua path
app.integrations.campaign_monitor.delete_webhook- Full name
campaign-monitor.campaignmonitor_delete_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_smart_emails Read
List transactional smart emails.
- Lua path
app.integrations.campaign_monitor.list_smart_emails- Full name
campaign-monitor.campaignmonitor_list_smart_emails
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_smart_email Read
Get transactional smart email details.
- Lua path
app.integrations.campaign_monitor.get_smart_email- Full name
campaign-monitor.campaignmonitor_get_smart_email
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
send_smart_email Write
Send a transactional smart email.
- Lua path
app.integrations.campaign_monitor.send_smart_email- Full name
campaign-monitor.campaignmonitor_send_smart_email
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
send_classic_email Write
Send a transactional classic email.
- Lua path
app.integrations.campaign_monitor.send_classic_email- Full name
campaign-monitor.campaignmonitor_send_classic_email
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_classic_email_groups Read
List transactional classic email groups.
- Lua path
app.integrations.campaign_monitor.list_classic_email_groups- Full name
campaign-monitor.campaignmonitor_list_classic_email_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_transactional_statistics Read
Get transactional delivery and engagement statistics.
- Lua path
app.integrations.campaign_monitor.get_transactional_statistics- Full name
campaign-monitor.campaignmonitor_get_transactional_statistics
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_transactional_messages Read
List transactional message timeline entries.
- Lua path
app.integrations.campaign_monitor.list_transactional_messages- Full name
campaign-monitor.campaignmonitor_list_transactional_messages
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_transactional_message Read
Get transactional message details.
- Lua path
app.integrations.campaign_monitor.get_transactional_message- Full name
campaign-monitor.campaignmonitor_get_transactional_message
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
resend_transactional_message Write
Resend a transactional message.
- Lua path
app.integrations.campaign_monitor.resend_transactional_message- Full name
campaign-monitor.campaignmonitor_resend_transactional_message
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
api_get Read
Call a safe relative Campaign Monitor API path with GET.
- Lua path
app.integrations.campaign_monitor.api_get- Full name
campaign-monitor.campaignmonitor_api_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
api_post Write
Call a safe relative Campaign Monitor API path with POST.
- Lua path
app.integrations.campaign_monitor.api_post- Full name
campaign-monitor.campaignmonitor_api_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
api_put Write
Call a safe relative Campaign Monitor API path with PUT.
- Lua path
app.integrations.campaign_monitor.api_put- Full name
campaign-monitor.campaignmonitor_api_put
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
api_delete Write
Call a safe relative Campaign Monitor API path with DELETE.
- Lua path
app.integrations.campaign_monitor.api_delete- Full name
campaign-monitor.campaignmonitor_api_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||