@clix-so/clix-agent-skills 0.1.7 → 0.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -6
- package/dist/bin/commands/install.js +18 -6
- package/dist/bin/utils/mcp.js +6 -0
- package/llms.txt +44 -0
- package/package.json +1 -1
- package/skills/api-triggered-campaigns/LICENSE.txt +203 -0
- package/skills/api-triggered-campaigns/SKILL.md +186 -0
- package/skills/api-triggered-campaigns/examples/trigger-campaign-node.js +62 -0
- package/skills/api-triggered-campaigns/examples/trigger-campaign-python.py +58 -0
- package/skills/api-triggered-campaigns/references/api-contract.md +86 -0
- package/skills/api-triggered-campaigns/references/backend-patterns.md +84 -0
- package/skills/api-triggered-campaigns/references/console-setup.md +74 -0
- package/skills/api-triggered-campaigns/references/debugging.md +77 -0
- package/skills/api-triggered-campaigns/references/personalization-and-dynamic-filters.md +54 -0
- package/skills/api-triggered-campaigns/references/security-and-keys.md +32 -0
- package/skills/api-triggered-campaigns/scripts/validate-api-trigger-plan.sh +159 -0
- package/skills/personalization/LICENSE.txt +204 -0
- package/skills/personalization/SKILL.md +128 -0
- package/skills/personalization/references/common-patterns.md +69 -0
- package/skills/personalization/references/debugging.md +89 -0
- package/skills/personalization/references/template-syntax.md +113 -0
- package/skills/personalization/scripts/validate-template.sh +134 -0
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Agent Skills for Clix
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@clix-so/clix-agent-skills)
|
|
4
|
-
[](https://www.npmjs.com/package/@clix-so/clix-agent-skills)
|
|
5
5
|
|
|
6
6
|
This repository contains a collection of **Agent Skills for Clix**. Each skill
|
|
7
7
|
is a self-contained package that can be loaded and executed by AI clients.
|
|
@@ -16,9 +16,9 @@ you can install skills in different ways.
|
|
|
16
16
|
|
|
17
17
|
### Universal CLI (Recommended)
|
|
18
18
|
|
|
19
|
-
For
|
|
20
|
-
|
|
21
|
-
the Clix MCP Server
|
|
19
|
+
For Amp, Claude Code, Codex, Copilot, Cursor, Goose, Letta, OpenCode, and VS
|
|
20
|
+
Code, we recommend using our installer to set up the skills and automatically
|
|
21
|
+
configure the Clix MCP Server.
|
|
22
22
|
|
|
23
23
|
#### Installation Modes
|
|
24
24
|
|
|
@@ -50,7 +50,7 @@ npx @clix-so/clix-agent-skills@latest install integration --client cursor --glob
|
|
|
50
50
|
|
|
51
51
|
# Install all available skills at once (repo root)
|
|
52
52
|
npx @clix-so/clix-agent-skills@latest install --all --client cursor
|
|
53
|
-
# This will install: integration, event-tracking, user-management
|
|
53
|
+
# This will install: integration, event-tracking, user-management, personalization, api-triggered-campaigns
|
|
54
54
|
|
|
55
55
|
# Install all available skills globally (system root)
|
|
56
56
|
npx @clix-so/clix-agent-skills@latest install --all --client cursor --global
|
|
@@ -58,11 +58,18 @@ npx @clix-so/clix-agent-skills@latest install --all --client cursor --global
|
|
|
58
58
|
|
|
59
59
|
### Available Skills
|
|
60
60
|
|
|
61
|
-
- **clix-integration**:
|
|
61
|
+
- **clix-integration**: Seamlessly integrate Clix Mobile SDK to your mobile
|
|
62
|
+
application with Clix MCP Server
|
|
62
63
|
- **clix-event-tracking**: Implement `Clix.trackEvent` with naming/schema best
|
|
63
64
|
practices and campaign-ready validation
|
|
64
65
|
- **clix-user-management**: Implement `Clix.setUserId` + user properties with
|
|
65
66
|
logout best practices, personalization (`user.*`), and audience targeting
|
|
67
|
+
- **clix-personalization**: Author and debug personalization templates for
|
|
68
|
+
message content, deep links/URLs, and audience targeting rules (`user.*`,
|
|
69
|
+
`event.*`, `trigger.*`, `device.*`)
|
|
70
|
+
- **clix-api-triggered-campaigns**: Configure API-triggered campaigns in the
|
|
71
|
+
console and trigger them from your backend with safe auth, dynamic filters
|
|
72
|
+
(`trigger.*`), and personalization patterns
|
|
66
73
|
|
|
67
74
|
**Supported Clients:**
|
|
68
75
|
|
|
@@ -101,6 +108,8 @@ Alternatively, you can install a single skill directly by running:
|
|
|
101
108
|
/plugin install clix-integration@clix-agent-skills
|
|
102
109
|
/plugin install clix-event-tracking@clix-agent-skills
|
|
103
110
|
/plugin install clix-user-management@clix-agent-skills
|
|
111
|
+
/plugin install clix-personalization@clix-agent-skills
|
|
112
|
+
/plugin install clix-api-triggered-campaigns@clix-agent-skills
|
|
104
113
|
```
|
|
105
114
|
|
|
106
115
|
Remember to restart Claude Code after installation to load the new skills.
|
|
@@ -120,11 +120,13 @@ async function installSkill(skillName, options) {
|
|
|
120
120
|
throw error;
|
|
121
121
|
}
|
|
122
122
|
// 4. MCP Configuration (always global/system root)
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
123
|
+
if (!options.skipMCPConfig) {
|
|
124
|
+
try {
|
|
125
|
+
await (0, mcp_1.configureMCP)(options.client);
|
|
126
|
+
}
|
|
127
|
+
catch (error) {
|
|
128
|
+
console.warn(chalk_1.default.yellow(`MCP Configuration warning: ${getErrorMessage(error)}`));
|
|
129
|
+
}
|
|
128
130
|
}
|
|
129
131
|
console.log(`\n${chalk_1.default.green("✔")} Skill ${chalk_1.default.bold(skillName)} is ready to use!`);
|
|
130
132
|
console.log(` - Docs: ${path_1.default.join(destPath, "SKILL.md")}`);
|
|
@@ -170,7 +172,8 @@ async function installAllSkills(options) {
|
|
|
170
172
|
let failCount = 0;
|
|
171
173
|
for (const skillName of skills) {
|
|
172
174
|
try {
|
|
173
|
-
|
|
175
|
+
// Avoid configuring MCP once per skill. We'll do it once at the end.
|
|
176
|
+
await installSkill(skillName, { ...options, skipMCPConfig: true });
|
|
174
177
|
successCount++;
|
|
175
178
|
}
|
|
176
179
|
catch (error) {
|
|
@@ -178,6 +181,15 @@ async function installAllSkills(options) {
|
|
|
178
181
|
failCount++;
|
|
179
182
|
}
|
|
180
183
|
}
|
|
184
|
+
// Configure MCP once per `--all` run (always global/system root)
|
|
185
|
+
if (successCount > 0) {
|
|
186
|
+
try {
|
|
187
|
+
await (0, mcp_1.configureMCP)(options.client);
|
|
188
|
+
}
|
|
189
|
+
catch (error) {
|
|
190
|
+
console.warn(chalk_1.default.yellow(`MCP Configuration warning: ${getErrorMessage(error)}`));
|
|
191
|
+
}
|
|
192
|
+
}
|
|
181
193
|
console.log();
|
|
182
194
|
if (failCount === 0) {
|
|
183
195
|
console.log(chalk_1.default.green(`\n✔ Successfully installed all ${chalk_1.default.bold(successCount)} skill(s)!`));
|
package/dist/bin/utils/mcp.js
CHANGED
|
@@ -159,7 +159,13 @@ function getClientConfig(client) {
|
|
|
159
159
|
format: "json",
|
|
160
160
|
};
|
|
161
161
|
}
|
|
162
|
+
// GitHub Copilot runs inside VS Code, so its MCP configuration lives in VS Code's MCP config.
|
|
163
|
+
// We accept `github` / `copilot` as aliases and write to the same file as `vscode`.
|
|
162
164
|
case "vscode":
|
|
165
|
+
case "github":
|
|
166
|
+
case "copilot":
|
|
167
|
+
case "github-copilot":
|
|
168
|
+
case "github copilot":
|
|
163
169
|
return {
|
|
164
170
|
path: path_1.default.join(home, ".vscode", "mcp.json"),
|
|
165
171
|
configKey: "mcpServers",
|
package/llms.txt
CHANGED
|
@@ -7,6 +7,32 @@ Each entry includes the file path, type, and description for semantic search.
|
|
|
7
7
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
+
## clix-api-triggered-campaigns
|
|
11
|
+
|
|
12
|
+
Helps developers configure API-triggered campaigns in the Clix console and trigger them from backend services with safe auth, payload schemas, dynamic audience filters (trigger.*), and personalization best practices. Use when the user mentions transactional notifications, backend-triggered sends, campaign_id trigger APIs, or "API-triggered campaigns".
|
|
13
|
+
|
|
14
|
+
- [clix-api-triggered-campaigns](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/SKILL.md): Helps developers configure API-triggered campaigns in the Clix console and trigger them from backend services with safe auth, payload schemas, dynamic audience filters (trigger.*), and personalization best practices. Use when the user mentions transactional notifications, backend-triggered sends, campaign_id trigger APIs, or "API-triggered campaigns".
|
|
15
|
+
|
|
16
|
+
### References
|
|
17
|
+
|
|
18
|
+
- [Api Contract (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/references/api-contract.md): Reference documentation for api-triggered-campaigns skill
|
|
19
|
+
- [Backend Patterns (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/references/backend-patterns.md): Reference documentation for api-triggered-campaigns skill
|
|
20
|
+
- [Console Setup (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/references/console-setup.md): Reference documentation for api-triggered-campaigns skill
|
|
21
|
+
- [Debugging (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/references/debugging.md): Reference documentation for api-triggered-campaigns skill
|
|
22
|
+
- [Personalization And Dynamic Filters (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/references/personalization-and-dynamic-filters.md): Reference documentation for api-triggered-campaigns skill
|
|
23
|
+
- [Security And Keys (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/references/security-and-keys.md): Reference documentation for api-triggered-campaigns skill
|
|
24
|
+
|
|
25
|
+
### Examples
|
|
26
|
+
|
|
27
|
+
- [Trigger Campaign Node (Example)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/examples/trigger-campaign-node.js): Code example for api-triggered-campaigns skill
|
|
28
|
+
- [Trigger Campaign Python (Example)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/examples/trigger-campaign-python.py): Code example for api-triggered-campaigns skill
|
|
29
|
+
|
|
30
|
+
### Scripts
|
|
31
|
+
|
|
32
|
+
- [Validate Api Trigger Plan (Script)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/api-triggered-campaigns/scripts/validate-api-trigger-plan.sh): Utility script for api-triggered-campaigns skill
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
10
36
|
## clix-event-tracking
|
|
11
37
|
|
|
12
38
|
Implements Clix event tracking (Clix.trackEvent) with consistent naming, safe property schemas, and campaign-ready validation. Use when adding, reviewing, or debugging event tracking; when configuring event-triggered campaigns; or when the user mentions events, tracking, funnels, or properties — or when the user types `clix-event-tracking`.
|
|
@@ -54,6 +80,24 @@ Integrates Clix Mobile SDK into iOS, Android, Flutter, and React Native projects
|
|
|
54
80
|
|
|
55
81
|
---
|
|
56
82
|
|
|
83
|
+
## clix-personalization
|
|
84
|
+
|
|
85
|
+
Helps developers author and debug Clix personalization templates (Liquid-style) for message content, deep links/URLs, and audience targeting. Use when the user mentions personalization variables, Liquid, templates, conditional logic, loops, filters, deep links, message logs, or when the user types `clix-personalization`.
|
|
86
|
+
|
|
87
|
+
- [clix-personalization](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/personalization/SKILL.md): Helps developers author and debug Clix personalization templates (Liquid-style) for message content, deep links/URLs, and audience targeting. Use when the user mentions personalization variables, Liquid, templates, conditional logic, loops, filters, deep links, message logs, or when the user types `clix-personalization`.
|
|
88
|
+
|
|
89
|
+
### References
|
|
90
|
+
|
|
91
|
+
- [Common Patterns (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/personalization/references/common-patterns.md): Reference documentation for personalization skill
|
|
92
|
+
- [Debugging (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/personalization/references/debugging.md): Reference documentation for personalization skill
|
|
93
|
+
- [Template Syntax (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/personalization/references/template-syntax.md): Reference documentation for personalization skill
|
|
94
|
+
|
|
95
|
+
### Scripts
|
|
96
|
+
|
|
97
|
+
- [Validate Template (Script)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/personalization/scripts/validate-template.sh): Utility script for personalization skill
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
57
101
|
## clix-user-management
|
|
58
102
|
|
|
59
103
|
Implements Clix user identification and user properties (setUserId, removeUserId, setUserProperty/setUserProperties, removeUserProperty/removeUserProperties) with safe schemas, logout best practices, and campaign-ready personalization/audience usage. Use when the user mentions login/logout, userId, user properties, personalization, audience targeting or when the user types `clix-user-management`.
|
package/package.json
CHANGED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
Copyright (c) 2026 Clix (https://clix.so/)
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright (c) 2026 Clix (https://clix.so/)
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: clix-api-triggered-campaigns
|
|
3
|
+
description:
|
|
4
|
+
Helps developers configure API-triggered campaigns in the Clix console and
|
|
5
|
+
trigger them from backend services with safe auth, payload schemas, dynamic
|
|
6
|
+
audience filters (trigger.*), and personalization best practices. Use when the
|
|
7
|
+
user mentions transactional notifications, backend-triggered sends,
|
|
8
|
+
campaign_id trigger APIs, or "API-triggered campaigns".
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# API-Triggered Campaigns (Backend → Clix)
|
|
12
|
+
|
|
13
|
+
Use this skill to set up **API-triggered campaigns** in the Clix console and
|
|
14
|
+
trigger them from your backend with dynamic data (`trigger.*`) for:
|
|
15
|
+
|
|
16
|
+
- Transactional notifications (orders, password reset, receipts)
|
|
17
|
+
- Workflow messages (assignments, approvals)
|
|
18
|
+
- System alerts (moderation, support tickets)
|
|
19
|
+
- Programmatic sends where marketers/ops should control content + targeting
|
|
20
|
+
|
|
21
|
+
## What the official docs guarantee (high-signal)
|
|
22
|
+
|
|
23
|
+
- API-triggered campaigns are configured in the console, then triggered via:
|
|
24
|
+
`POST /api/v1/campaigns/{campaign_id}:trigger`
|
|
25
|
+
- Authentication uses **secret** headers:
|
|
26
|
+
- `X-Clix-Project-ID`
|
|
27
|
+
- `X-Clix-API-Key`
|
|
28
|
+
- Request `properties` become **`trigger.*`** for:
|
|
29
|
+
- **Dynamic audience filtering** (console audience rules)
|
|
30
|
+
- **Personalization** in templates (title/body/deep links)
|
|
31
|
+
- `audience.broadcast=true` sends to all users eligible under the campaign’s
|
|
32
|
+
segment definition; `audience.targets` narrows to specific users/devices
|
|
33
|
+
(still filtered by the segment definition).
|
|
34
|
+
- Dynamic audience filters are intentionally constrained for performance: **max
|
|
35
|
+
3 attributes** in the audience definition.
|
|
36
|
+
|
|
37
|
+
## MCP-first (source of truth)
|
|
38
|
+
|
|
39
|
+
If Clix MCP tools are available, treat them as the **source of truth**:
|
|
40
|
+
|
|
41
|
+
- Use `clix-mcp-server:search_docs` to confirm the latest API contract + limits:
|
|
42
|
+
- query examples:
|
|
43
|
+
- `"API-triggered campaign trigger endpoint"`
|
|
44
|
+
- `"campaigns/{campaign_id}:trigger audience targets broadcast"`
|
|
45
|
+
- `"trigger.* dynamic audience filters limitations"`
|
|
46
|
+
|
|
47
|
+
If MCP tools are not available, use the bundled references:
|
|
48
|
+
|
|
49
|
+
- API contract → `references/api-contract.md`
|
|
50
|
+
- Console setup + dynamic filters → `references/console-setup.md`
|
|
51
|
+
- Backend patterns (auth, retries, timeouts) → `references/backend-patterns.md`
|
|
52
|
+
- Security/key handling → `references/security-and-keys.md`
|
|
53
|
+
- Personalization + dynamic filters →
|
|
54
|
+
`references/personalization-and-dynamic-filters.md`
|
|
55
|
+
- Debugging checklist → `references/debugging.md`
|
|
56
|
+
|
|
57
|
+
## Workflow (copy + check off)
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
API-triggered campaign progress:
|
|
61
|
+
- [ ] 1) Confirm goals + trigger source (what backend event sends the message?)
|
|
62
|
+
- [ ] 2) Define campaign contract (properties keys/types; PII policy)
|
|
63
|
+
- [ ] 3) Configure campaign in console (API-triggered + audience rules + templates)
|
|
64
|
+
- [ ] 4) Implement backend trigger wrapper (auth, timeout, retries, logging)
|
|
65
|
+
- [ ] 5) Validate trigger plan JSON (schema + naming + safety)
|
|
66
|
+
- [ ] 6) Verify in Clix (test payloads, Message Logs, segment matching)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## 1) Confirm the minimum inputs
|
|
70
|
+
|
|
71
|
+
Ask only what’s needed:
|
|
72
|
+
|
|
73
|
+
- **Campaign**: where is it in the console? do you already have `campaign_id`?
|
|
74
|
+
- **Channel**: push / in-app / email / etc. (affects message template fields)
|
|
75
|
+
- **Audience mode**: broadcast vs explicit targets
|
|
76
|
+
- **Dynamic filter keys**: which `trigger.*` keys are used in audience rules
|
|
77
|
+
- **Properties**: list of keys + types + example values (avoid PII by default)
|
|
78
|
+
- **Backend**: runtime and HTTP client (Node/Fetch, Axios, Python, Go, etc.)
|
|
79
|
+
|
|
80
|
+
## 2) Create a “Trigger Plan” (before touching backend code)
|
|
81
|
+
|
|
82
|
+
Create `api-trigger-plan.json` in `.clix/` (recommended) or project root.
|
|
83
|
+
|
|
84
|
+
**Recommended location**: `.clix/api-trigger-plan.json`
|
|
85
|
+
|
|
86
|
+
**Plan schema (high-level):**
|
|
87
|
+
|
|
88
|
+
- `campaign_id` (string)
|
|
89
|
+
- `audience.mode`: `"broadcast" | "targets" | "default"`
|
|
90
|
+
- `audience.targets` (if mode is `"targets"`)
|
|
91
|
+
- `dynamic_filter_keys` (array of up to 3 snake_case keys)
|
|
92
|
+
- `properties` (map of snake_case keys → `{ type, required?, example?, pii? }`)
|
|
93
|
+
|
|
94
|
+
Example:
|
|
95
|
+
|
|
96
|
+
```json
|
|
97
|
+
{
|
|
98
|
+
"campaign_id": "019aa002-1d0e-7407-a0c5-5bfa8dd2be30",
|
|
99
|
+
"audience": {
|
|
100
|
+
"mode": "broadcast"
|
|
101
|
+
},
|
|
102
|
+
"dynamic_filter_keys": ["store_location"],
|
|
103
|
+
"properties": {
|
|
104
|
+
"store_location": {
|
|
105
|
+
"type": "string",
|
|
106
|
+
"required": true,
|
|
107
|
+
"example": "San Francisco"
|
|
108
|
+
},
|
|
109
|
+
"order_id": { "type": "string", "required": true, "example": "ORD-12345" },
|
|
110
|
+
"item_count": { "type": "number", "required": true, "example": 3 },
|
|
111
|
+
"pickup_time": { "type": "string", "required": false, "example": "2:30 PM" }
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## 3) Configure campaign in the console (API-triggered)
|
|
117
|
+
|
|
118
|
+
- Set the campaign type to **API-Triggered**.
|
|
119
|
+
- Build audience rules using `{{ trigger.* }}` for dynamic filters.
|
|
120
|
+
- Use `{{ trigger.* }}` in message templates + deep links.
|
|
121
|
+
|
|
122
|
+
See: `references/console-setup.md` for exact guidance and limitations.
|
|
123
|
+
|
|
124
|
+
## 4) Implement backend trigger wrapper (best practices)
|
|
125
|
+
|
|
126
|
+
Backend wrapper responsibilities:
|
|
127
|
+
|
|
128
|
+
- **Auth**: load `X-Clix-Project-ID` and `X-Clix-API-Key` from
|
|
129
|
+
environment/secret store (never commit).
|
|
130
|
+
- **Timeout**: set a short timeout (e.g., 3–10s) and fail fast.
|
|
131
|
+
- **Retries**: retry only on transient failures (network/5xx), with backoff; do
|
|
132
|
+
not retry blindly on 4xx.
|
|
133
|
+
- **Dedupe**: prevent double-sends in your system (e.g., unique key per order
|
|
134
|
+
event) since the API call is “send-like”.
|
|
135
|
+
- **Logging**: log `campaign_id`, your correlation id (order id), and the Clix
|
|
136
|
+
response (e.g., `trigger_id`).
|
|
137
|
+
|
|
138
|
+
Copy/paste examples:
|
|
139
|
+
|
|
140
|
+
- Node: `examples/trigger-campaign-node.js`
|
|
141
|
+
- Python: `examples/trigger-campaign-python.py`
|
|
142
|
+
|
|
143
|
+
## 5) Validate the plan (fast feedback loop)
|
|
144
|
+
|
|
145
|
+
Run:
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
bash <skill-dir>/scripts/validate-api-trigger-plan.sh .clix/api-trigger-plan.json
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
This validator checks:
|
|
152
|
+
|
|
153
|
+
- valid JSON
|
|
154
|
+
- `campaign_id` present
|
|
155
|
+
- `dynamic_filter_keys` is ≤ 3 and snake_case
|
|
156
|
+
- `properties` keys are snake_case and have valid types
|
|
157
|
+
- example values match declared types
|
|
158
|
+
- `targets` entries specify exactly one of `project_user_id` or `device_id`
|
|
159
|
+
|
|
160
|
+
## 6) Verify (Clix + end-to-end)
|
|
161
|
+
|
|
162
|
+
Minimum verification:
|
|
163
|
+
|
|
164
|
+
- Campaign is **API-Triggered** and `campaign_id` matches.
|
|
165
|
+
- If using dynamic audience filters, the `trigger.*` keys exist in the API call
|
|
166
|
+
and match audience rules exactly.
|
|
167
|
+
- Trigger once with a known-good payload; confirm delivery + inspect Message
|
|
168
|
+
Logs for rendering errors.
|
|
169
|
+
|
|
170
|
+
See `references/debugging.md`.
|
|
171
|
+
|
|
172
|
+
## Progressive Disclosure
|
|
173
|
+
|
|
174
|
+
- **Level 1**: This `SKILL.md` (always loaded)
|
|
175
|
+
- **Level 2**: `references/` (load when implementing details)
|
|
176
|
+
- **Level 3**: `examples/` (load when copy/pasting backend code)
|
|
177
|
+
- **Level 4**: `scripts/` (execute directly; do not load into context)
|
|
178
|
+
|
|
179
|
+
## References
|
|
180
|
+
|
|
181
|
+
- `references/api-contract.md`
|
|
182
|
+
- `references/console-setup.md`
|
|
183
|
+
- `references/backend-patterns.md`
|
|
184
|
+
- `references/security-and-keys.md`
|
|
185
|
+
- `references/personalization-and-dynamic-filters.md`
|
|
186
|
+
- `references/debugging.md`
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Minimal Node.js example: trigger an API-triggered campaign.
|
|
3
|
+
*
|
|
4
|
+
* Requirements:
|
|
5
|
+
* - Node 18+ (fetch is available) OR replace with your HTTP client
|
|
6
|
+
* - Env vars:
|
|
7
|
+
* - CLIX_PROJECT_ID
|
|
8
|
+
* - CLIX_API_KEY
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
const CLIX_PROJECT_ID = process.env.CLIX_PROJECT_ID;
|
|
12
|
+
const CLIX_API_KEY = process.env.CLIX_API_KEY;
|
|
13
|
+
|
|
14
|
+
if (!CLIX_PROJECT_ID || !CLIX_API_KEY) {
|
|
15
|
+
throw new Error("Missing CLIX_PROJECT_ID or CLIX_API_KEY");
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
async function triggerCampaign({ campaignId, audience, properties }) {
|
|
19
|
+
const url = `https://api.clix.so/api/v1/campaigns/${campaignId}:trigger`;
|
|
20
|
+
|
|
21
|
+
const res = await fetch(url, {
|
|
22
|
+
method: "POST",
|
|
23
|
+
headers: {
|
|
24
|
+
"X-Clix-Project-ID": CLIX_PROJECT_ID,
|
|
25
|
+
"X-Clix-API-Key": CLIX_API_KEY,
|
|
26
|
+
"Content-Type": "application/json",
|
|
27
|
+
},
|
|
28
|
+
body: JSON.stringify({
|
|
29
|
+
audience,
|
|
30
|
+
properties,
|
|
31
|
+
}),
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
const text = await res.text();
|
|
35
|
+
if (!res.ok) {
|
|
36
|
+
throw new Error(`Clix trigger failed (${res.status}): ${text}`);
|
|
37
|
+
}
|
|
38
|
+
return JSON.parse(text);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// Example usage
|
|
42
|
+
async function main() {
|
|
43
|
+
const campaignId = "019aa002-1d0e-7407-a0c5-5bfa8dd2be30"; // replace
|
|
44
|
+
|
|
45
|
+
const payload = {
|
|
46
|
+
audience: { broadcast: true },
|
|
47
|
+
properties: {
|
|
48
|
+
store_location: "San Francisco",
|
|
49
|
+
order_id: "ORD-12345",
|
|
50
|
+
item_count: 3,
|
|
51
|
+
pickup_time: "2:30 PM",
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
const out = await triggerCampaign({ campaignId, ...payload });
|
|
56
|
+
console.log(out); // { trigger_id: "..." }
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
main().catch((e) => {
|
|
60
|
+
console.error(e);
|
|
61
|
+
process.exit(1);
|
|
62
|
+
});
|