clix-api-triggered-campaigns

Configure and trigger Clix API-triggered campaigns with dynamic payloads.

5|Updated Dec 30, 2025
One-click install
npx skills add https://github.com/clix-so/skills --skill clix-api-triggered-campaigns
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: clix-api-triggered-campaigns
Source: https://github.com/clix-so/skills/tree/main/skills/api-triggered-campaigns
Command: npx skills add https://github.com/clix-so/skills --skill clix-api-triggered-campaigns

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Configuring API-triggered campaigns and triggering them from backend services can be error-prone without a stable contract, validation, and clear guidance.

Core Features & Use Cases

  • Backend-ready API-triggered campaign setup in Clix console
  • Dynamic payloads via trigger.*, enabling personalized targeting and templates
  • Supported by a formal plan file (api-trigger-plan.json) and a validation script
  • Quick-start samples in Node.js and Python for triggering test campaigns

Quick Start

Install the skill and run the included example to trigger a test API-triggered campaign.

Frequently Asked Questions about clix-api-triggered-campaigns

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I trigger API campaigns from a backend service with dynamic payloads?

To trigger API campaigns from a backend service, configure dynamic payloads using trigger.* properties for personalized targeting and templates. The setup enforces plan validation, strict snake_case key naming, and safety constraints to ensure reliable, auditable delivery of transactional and workflow messages.

What authentication is needed to send API-triggered transactional messages?

API-triggered transactional messages require authentication through X-Clix-Project-ID and X-Clix-API-Key headers. Your backend service must include these credentials in requests to validate access and trigger campaigns configured in the Clix console.

Can I use Python or Node.js to send API-triggered campaign requests?

Yes, you can use Python or Node.js to send API-triggered campaign requests. The setup includes quick-start samples in both languages demonstrating how to construct backend requests with dynamic payloads to trigger test campaigns.

What are the payload constraints for backend API-triggered campaigns?

Backend API-triggered campaigns enforce strict payload constraints including a maximum of 3 dynamic attributes, mandatory snake_case key naming, and non-PII data requirements. These safety constraints enforce reliable, auditable delivery and plan validation.

How does audience targeting work for API-triggered campaigns?

Audience targeting for API-triggered campaigns works by applying audience rules alongside dynamic trigger.* properties within your payload. This combination allows backend services to send personalized transactional and workflow messages based on the configured template.

Why are my API-triggered campaign payloads failing validation?

API-triggered campaign payloads fail validation if they violate strict safety constraints. Ensure your payload uses snake_case keys, contains no PII data, includes a maximum of 3 dynamic attributes, and conforms to the api-trigger-plan.json validation script rules.