arkaos 4.26.0 → 4.28.0

package/departments/marketing/tools/integrations/livestorm.md

@@ -0,0 +1,313 @@
+# Livestorm
+
+Video engagement platform for webinars, virtual events, and online meetings with built-in analytics and integrations.
+
+## Capabilities
+
+| Integration | Available | Notes |
+|-------------|-----------|-------|
+| API | ✓ | Events, Sessions, People, Recordings, Webhooks |
+| MCP | - | Not available |
+| CLI | ✓ | [livestorm.js](../clis/livestorm.js) |
+| SDK | - | REST API with JSON:API format |
+
+## Authentication
+
+- **Type**: API Token
+- **Header**: `Authorization: {API_TOKEN}` (no prefix)
+- **Content-Type**: `application/vnd.api+json` (JSON:API)
+- **Scopes**: Identity, Events, Admin, Webhooks
+- **Get token**: Account Settings > Integrations > Public API
+- **Docs**: https://developers.livestorm.co/
+
+## Common Agent Operations
+
+### Ping (test authentication)
+
+```bash
+GET https://api.livestorm.co/v1/ping
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### List events
+
+```bash
+GET https://api.livestorm.co/v1/events?page[number]=1&page[size]=25
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### Create an event
+
+```bash
+POST https://api.livestorm.co/v1/events
+
+Headers:
+  Authorization: {API_TOKEN}
+  Content-Type: application/vnd.api+json
+
+{
+  "data": {
+    "type": "events",
+    "attributes": {
+      "title": "Product Demo Webinar",
+      "slug": "product-demo-webinar",
+      "estimated_duration": 60
+    }
+  }
+}
+```
+
+### Get event details
+
+```bash
+GET https://api.livestorm.co/v1/events/{event_id}
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### Update an event
+
+```bash
+PATCH https://api.livestorm.co/v1/events/{event_id}
+
+Headers:
+  Authorization: {API_TOKEN}
+  Content-Type: application/vnd.api+json
+
+{
+  "data": {
+    "type": "events",
+    "id": "{event_id}",
+    "attributes": {
+      "title": "Updated Webinar Title"
+    }
+  }
+}
+```
+
+### List sessions
+
+```bash
+GET https://api.livestorm.co/v1/sessions?page[number]=1&page[size]=25
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### Create a session for an event
+
+```bash
+POST https://api.livestorm.co/v1/events/{event_id}/sessions
+
+Headers:
+  Authorization: {API_TOKEN}
+  Content-Type: application/vnd.api+json
+
+{
+  "data": {
+    "type": "sessions",
+    "attributes": {
+      "estimated_started_at": "2025-06-15T14:00:00.000Z",
+      "timezone": "America/New_York"
+    }
+  }
+}
+```
+
+### Register someone for a session
+
+```bash
+POST https://api.livestorm.co/v1/sessions/{session_id}/people
+
+Headers:
+  Authorization: {API_TOKEN}
+  Content-Type: application/vnd.api+json
+
+{
+  "data": {
+    "type": "people",
+    "attributes": {
+      "fields": {
+        "email": "attendee@example.com",
+        "first_name": "Jane",
+        "last_name": "Doe"
+      }
+    }
+  }
+}
+```
+
+### List session participants
+
+```bash
+GET https://api.livestorm.co/v1/sessions/{session_id}/people?page[number]=1&page[size]=25
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### Remove a registrant from session
+
+```bash
+DELETE https://api.livestorm.co/v1/sessions/{session_id}/people?filter[email]=attendee@example.com
+
+Headers:
+  Authorization: {API_TOKEN}
+```
+
+### List session chat messages
+
+```bash
+GET https://api.livestorm.co/v1/sessions/{session_id}/chat-messages
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### List session questions
+
+```bash
+GET https://api.livestorm.co/v1/sessions/{session_id}/questions
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### Get session recordings
+
+```bash
+GET https://api.livestorm.co/v1/sessions/{session_id}/recordings
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### List all people
+
+```bash
+GET https://api.livestorm.co/v1/people?page[number]=1&page[size]=25
+
+Headers:
+  Authorization: {API_TOKEN}
+  Accept: application/vnd.api+json
+```
+
+### Create a webhook
+
+```bash
+POST https://api.livestorm.co/v1/webhooks
+
+Headers:
+  Authorization: {API_TOKEN}
+  Content-Type: application/vnd.api+json
+
+{
+  "data": {
+    "type": "webhooks",
+    "attributes": {
+      "target_url": "https://example.com/webhook",
+      "event_name": "attendance"
+    }
+  }
+}
+```
+
+## API Pattern
+
+Livestorm follows the JSON:API specification:
+- All responses use `data`, `attributes`, `relationships` structure
+- Pagination: `page[number]` and `page[size]` query parameters
+- Filtering: `filter[field]=value` query parameters
+- Events contain multiple Sessions; Sessions contain People
+- ISO 8601 timestamps throughout
+
+## Key Metrics
+
+### Event Metrics
+- `title` - Event title
+- `slug` - URL-friendly identifier
+- `estimated_duration` - Duration in minutes
+- `registration_page_enabled` - Registration page status
+- `everyone_can_speak` - Whether all attendees can speak
+
+### Session Metrics
+- `status` - Session status (upcoming, live, past)
+- `estimated_started_at` - Scheduled start time
+- `started_at` - Actual start time
+- `ended_at` - Actual end time
+- `timezone` - Session timezone
+- `attendees_count` - Number of attendees
+- `registrants_count` - Number of registrants
+
+### People Metrics
+- `email` - Contact email
+- `first_name` / `last_name` - Contact name
+- `registrant_detail` - Registration metadata
+- `attendance_rate` - Attendance percentage
+- `attended_at` - Join timestamp
+- `left_at` - Leave timestamp
+
+## Parameters
+
+### Pagination
+- `page[number]` - Page number (default: 1)
+- `page[size]` - Items per page (default: 25)
+
+### Event Attributes
+- `title` - Event title (required for create)
+- `slug` - URL slug
+- `description` - Event description
+- `estimated_duration` - Duration in minutes
+
+### Session Attributes
+- `estimated_started_at` - ISO 8601 start time
+- `timezone` - IANA timezone string
+
+### Registration Fields
+- `email` - Registrant email (required)
+- `first_name` - First name
+- `last_name` - Last name
+
+### Webhook Events
+- `attendance` - Triggered on session attendance
+- `registration` - Triggered on new registration
+- `unregistration` - Triggered on unregistration
+
+## When to Use
+
+- Hosting product demos and marketing webinars
+- Automated webinar registration and attendee management
+- Tracking webinar engagement and attendance rates
+- Retrieving session recordings for content repurposing
+- Building custom registration pages with API-driven registration
+- Syncing webinar data with CRM and marketing automation
+- Monitoring session Q&A and chat for follow-up
+
+## Rate Limits
+
+- **10,000 API calls per 30-day period** (organization-wide)
+- Rate limits shared across all API tokens in the organization
+- Plan accordingly for high-volume operations
+- Use webhooks instead of polling to conserve quota
+
+## Relevant Skills
+
+- webinar-marketing
+- event-marketing
+- lead-generation
+- content-strategy
+- lifecycle-marketing
+- customer-engagement

package/departments/marketing/tools/integrations/mailchimp.md

@@ -0,0 +1,150 @@
+# Mailchimp
+
+Email marketing platform for campaigns, automation, and audience management.
+
+## Capabilities
+
+| Integration | Available | Notes |
+|-------------|-----------|-------|
+| API | ✓ | Marketing API for campaigns, audiences, automation |
+| MCP | ✓ | Available via Mailchimp MCP server |
+| CLI | - | Not available |
+| SDK | ✓ | Official SDKs for multiple languages |
+
+## Authentication
+
+- **Type**: API Key or OAuth 2.0
+- **Header**: `Authorization: Bearer {api_key}` or `Authorization: apikey {api_key}`
+- **Base URL**: `https://{dc}.api.mailchimp.com/3.0/` (dc = datacenter from API key)
+
+## Common Agent Operations
+
+### List audiences (lists)
+
+```bash
+GET https://{dc}.api.mailchimp.com/3.0/lists
+```
+
+### Get audience members
+
+```bash
+GET https://{dc}.api.mailchimp.com/3.0/lists/{list_id}/members?count=100
+```
+
+### Add subscriber
+
+```bash
+POST https://{dc}.api.mailchimp.com/3.0/lists/{list_id}/members
+
+{
+  "email_address": "user@example.com",
+  "status": "subscribed",
+  "merge_fields": {
+    "FNAME": "John",
+    "LNAME": "Doe"
+  }
+}
+```
+
+### Update subscriber
+
+```bash
+PATCH https://{dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}
+
+{
+  "merge_fields": {
+    "FNAME": "Jane"
+  },
+  "tags": ["customer", "premium"]
+}
+```
+
+### Get campaigns
+
+```bash
+GET https://{dc}.api.mailchimp.com/3.0/campaigns?count=20
+```
+
+### Get campaign report
+
+```bash
+GET https://{dc}.api.mailchimp.com/3.0/reports/{campaign_id}
+```
+
+### Create campaign
+
+```bash
+POST https://{dc}.api.mailchimp.com/3.0/campaigns
+
+{
+  "type": "regular",
+  "recipients": {
+    "list_id": "{list_id}"
+  },
+  "settings": {
+    "subject_line": "Your Subject",
+    "from_name": "Your Name",
+    "reply_to": "reply@example.com"
+  }
+}
+```
+
+### Send campaign
+
+```bash
+POST https://{dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/send
+```
+
+### List automations
+
+```bash
+GET https://{dc}.api.mailchimp.com/3.0/automations
+```
+
+## Key Metrics
+
+### Campaign Report Fields
+- `emails_sent` - Total sent
+- `opens` - Open count
+- `unique_opens` - Unique opens
+- `open_rate` - Open rate
+- `clicks` - Click count
+- `click_rate` - Click rate
+- `unsubscribes` - Unsubscribe count
+- `bounces` - Bounce count
+
+### Subscriber Hash
+
+Calculate subscriber hash for updates:
+```javascript
+const hash = md5(email.toLowerCase());
+```
+
+## Subscriber Statuses
+
+- `subscribed` - Active subscriber
+- `unsubscribed` - Unsubscribed
+- `cleaned` - Hard bounce
+- `pending` - Awaiting confirmation
+- `transactional` - Transactional only
+
+## When to Use
+
+- Managing email lists and subscribers
+- Creating and sending email campaigns
+- Setting up email automation
+- Analyzing campaign performance
+- Segmenting audiences
+- A/B testing emails
+
+## Rate Limits
+
+- 10 concurrent connections
+- 10 requests per second
+- Batch endpoints for bulk operations
+
+## Relevant Skills
+
+- emails
+- analytics
+- referrals

package/departments/marketing/tools/integrations/mention-me.md

@@ -0,0 +1,160 @@
+# Mention Me
+
+Enterprise referral marketing platform for customer advocacy.
+
+## Capabilities
+
+| Integration | Available | Notes |
+|-------------|-----------|-------|
+| API | ✓ | REST API for referrals, customers, rewards |
+| MCP | - | Not available |
+| CLI | - | Not available |
+| SDK | - | JavaScript widget for embedding |
+
+## Authentication
+
+- **Type**: API Key
+- **Header**: `Authorization: Bearer {api_key}`
+- **Environment**: Separate keys for sandbox and production
+
+## Common Agent Operations
+
+### Create referral offer
+
+```bash
+POST https://api.mention-me.com/api/v2/referrer-offer
+
+{
+  "email": "customer@example.com",
+  "firstname": "John",
+  "lastname": "Doe",
+  "order_number": "ORD-123",
+  "order_total": 99.99,
+  "order_currency": "USD"
+}
+```
+
+### Get referral link for customer
+
+```bash
+GET https://api.mention-me.com/api/v2/referrer/{customer_id}/share-links
+```
+
+### Record referee (referred customer)
+
+```bash
+POST https://api.mention-me.com/api/v2/referee
+
+{
+  "email": "referred@example.com",
+  "firstname": "Jane",
+  "referrer_code": "JOHN123",
+  "order_number": "ORD-456",
+  "order_total": 149.99
+}
+```
+
+### Get referral status
+
+```bash
+GET https://api.mention-me.com/api/v2/referral/{referral_id}
+```
+
+### List referrals for customer
+
+```bash
+GET https://api.mention-me.com/api/v2/referrer/{customer_id}/referrals
+```
+
+### Get reward balance
+
+```bash
+GET https://api.mention-me.com/api/v2/referrer/{customer_id}/rewards
+```
+
+### Redeem reward
+
+```bash
+POST https://api.mention-me.com/api/v2/referrer/{customer_id}/rewards/redeem
+
+{
+  "reward_id": "RWD-123",
+  "order_number": "ORD-789"
+}
+```
+
+## JavaScript Widget
+
+### Embed referral widget
+
+```html
+<div id="mmWrapper"></div>
+<script>
+  window.MentionMe = window.MentionMe || [];
+  MentionMe.push({
+    type: 'offer',
+    customer: {
+      email: 'customer@example.com',
+      firstname: 'John',
+      order_number: 'ORD-123'
+    }
+  });
+</script>
+<script src="https://tag.mention-me.com/client/{partner_code}.js" async></script>
+```
+
+### Name share widget
+
+```javascript
+MentionMe.push({
+  type: 'nameShare',
+  customer: {
+    email: 'customer@example.com'
+  }
+});
+```
+
+## Webhook Events
+
+| Event | When |
+|-------|------|
+| `referral.created` | New referral tracked |
+| `referral.converted` | Referral completed purchase |
+| `reward.earned` | Reward unlocked |
+| `reward.redeemed` | Reward used |
+
+## Key Features
+
+- **A/B testing** - Built-in experiment framework
+- **Fraud prevention** - Automatic fraud detection
+- **Multi-channel** - Share via link, email, social
+- **Name sharing** - Refer by name, not code
+- **Segmentation** - Different offers by segment
+- **Analytics** - Referral program reporting
+
+## Key Objects
+
+- **Referrer** - Customer who refers
+- **Referee** - Customer who is referred
+- **Referral** - Connection between referrer and referee
+- **Offer** - Referral program configuration
+- **Reward** - Incentive earned
+
+## When to Use
+
+- Enterprise referral programs
+- Multi-market referral campaigns
+- A/B testing referral offers
+- Fraud-resistant referral tracking
+- Name-based sharing programs
+
+## Rate Limits
+
+- 1000 requests per minute
+- Contact for higher limits
+
+## Relevant Skills
+
+- referrals
+- pricing
+- analytics