arkaos 4.26.0 → 4.28.0

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

@@ -0,0 +1,292 @@
+# Intercom
+
+Customer messaging and support platform API for managing contacts, conversations, messages, companies, articles, and tags.
+
+## Capabilities
+
+| Integration | Available | Notes |
+|-------------|-----------|-------|
+| API | ✓ | REST API v2.11+ - contacts, conversations, messages, companies, articles, tags |
+| MCP | - | Not available |
+| CLI | ✓ | [intercom.js](../clis/intercom.js) |
+| SDK | ✓ | Node.js, Ruby, Python, PHP, Go |
+
+## Authentication
+
+- **Type**: Bearer Token (Access Token or OAuth 2.0)
+- **Header**: `Authorization: Bearer {token}`
+- **Version Header**: `Intercom-Version: 2.11`
+- **Get key**: Developer Hub at https://app.intercom.com/a/apps/_/developer-hub
+
+## Common Agent Operations
+
+### List contacts
+
+```bash
+GET https://api.intercom.io/contacts
+```
+
+### Get a contact
+
+```bash
+GET https://api.intercom.io/contacts/{id}
+```
+
+### Create a contact
+
+```bash
+POST https://api.intercom.io/contacts
+
+{
+  "role": "user",
+  "email": "user@example.com",
+  "name": "Jane Doe",
+  "custom_attributes": {
+    "plan": "pro"
+  }
+}
+```
+
+### Update a contact
+
+```bash
+PUT https://api.intercom.io/contacts/{id}
+
+{
+  "name": "Jane Smith",
+  "custom_attributes": {
+    "plan": "enterprise"
+  }
+}
+```
+
+### Search contacts
+
+```bash
+POST https://api.intercom.io/contacts/search
+
+{
+  "query": {
+    "field": "email",
+    "operator": "=",
+    "value": "user@example.com"
+  }
+}
+```
+
+### Delete a contact
+
+```bash
+DELETE https://api.intercom.io/contacts/{id}
+```
+
+### List conversations
+
+```bash
+GET https://api.intercom.io/conversations
+```
+
+### Get a conversation
+
+```bash
+GET https://api.intercom.io/conversations/{id}
+```
+
+### Search conversations
+
+```bash
+POST https://api.intercom.io/conversations/search
+
+{
+  "query": {
+    "field": "open",
+    "operator": "=",
+    "value": true
+  }
+}
+```
+
+### Reply to a conversation
+
+```bash
+POST https://api.intercom.io/conversations/{id}/reply
+
+{
+  "message_type": "comment",
+  "type": "admin",
+  "admin_id": "{admin_id}",
+  "body": "Thanks for reaching out!"
+}
+```
+
+### Create a message
+
+```bash
+POST https://api.intercom.io/messages
+
+{
+  "message_type": "inapp",
+  "body": "Welcome to our platform!",
+  "from": {
+    "type": "admin",
+    "id": "{admin_id}"
+  },
+  "to": {
+    "type": "user",
+    "id": "{user_id}"
+  }
+}
+```
+
+### List companies
+
+```bash
+GET https://api.intercom.io/companies
+```
+
+### Create or update a company
+
+```bash
+POST https://api.intercom.io/companies
+
+{
+  "company_id": "company_123",
+  "name": "Acme Corp",
+  "plan": "enterprise",
+  "custom_attributes": {
+    "industry": "Technology"
+  }
+}
+```
+
+### List tags
+
+```bash
+GET https://api.intercom.io/tags
+```
+
+### Create a tag
+
+```bash
+POST https://api.intercom.io/tags
+
+{
+  "name": "VIP Customer"
+}
+```
+
+### Tag a contact
+
+```bash
+POST https://api.intercom.io/contacts/{contact_id}/tags
+
+{
+  "id": "{tag_id}"
+}
+```
+
+### List articles
+
+```bash
+GET https://api.intercom.io/articles
+```
+
+### Create an article
+
+```bash
+POST https://api.intercom.io/articles
+
+{
+  "title": "Getting Started Guide",
+  "body": "<p>Welcome to our platform...</p>",
+  "author_id": "{admin_id}",
+  "state": "published"
+}
+```
+
+### List admins
+
+```bash
+GET https://api.intercom.io/admins
+```
+
+### Submit events
+
+```bash
+POST https://api.intercom.io/events
+
+{
+  "event_name": "purchased-item",
+  "created_at": 1706140800,
+  "user_id": "user_123",
+  "metadata": {
+    "item_name": "Pro Plan",
+    "price": 99.00
+  }
+}
+```
+
+## Key Metrics
+
+### Contact Data
+- `id` - Unique contact identifier
+- `role` - user or lead
+- `email` - Contact email
+- `name` - Contact name
+- `created_at` / `updated_at` - Timestamps
+- `last_seen_at` - Last activity
+- `custom_attributes` - Custom data fields
+- `tags` - Applied tags
+- `companies` - Associated companies
+
+### Conversation Data
+- `id` - Conversation identifier
+- `state` - open, closed, snoozed
+- `open` - Boolean open status
+- `read` - Read status
+- `priority` - Priority level
+- `statistics` - Response times, counts
+- `conversation_parts` - Message history
+
+## Parameters
+
+### List Contacts
+- `per_page` - Results per page (default 50, max 150)
+- `starting_after` - Pagination cursor
+
+### List Conversations
+- `per_page` - Results per page (default 20, max 150)
+- `starting_after` - Pagination cursor
+
+### Search (Contacts & Conversations)
+- `query.field` - Field to search
+- `query.operator` - Comparison operator (=, !=, >, <, ~, IN, NIN)
+- `query.value` - Search value
+- `pagination.per_page` - Results per page
+- `pagination.starting_after` - Cursor for next page
+- `sort.field` / `sort.order` - Sort configuration
+
+## When to Use
+
+- Managing customer contact records and segments
+- Automating customer messaging and onboarding
+- Monitoring and responding to support conversations
+- Tracking customer events and behavior
+- Building custom support workflows
+- Syncing customer data between platforms
+
+## Rate Limits
+
+- **Default**: 10,000 API calls per minute per app
+- **Per workspace**: 25,000 API calls per minute
+- Distributed in 10-second windows (resets every 10 seconds)
+- Headers: `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`
+- HTTP 429 returned when exceeded
+
+## Relevant Skills
+
+- customer-onboarding
+- customer-retention
+- lead-generation
+- customer-support
+- in-app-messaging

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

@@ -0,0 +1,182 @@
+# Introw PRM
+
+Partner Relationship Management platform for managing channel partners, tracking partner-sourced deals, commissions, tasks, and engagement — with built-in business review generation.
+
+## Capabilities
+
+| Integration | Available | Notes |
+|-------------|-----------|-------|
+| API | - | Not available |
+| MCP | ✓ | Full read/write via Claude connector |
+| CLI | - | Not available |
+| SDK | - | Not available |
+
+## Authentication
+
+- **Type**: OAuth2 (via MCP connector)
+- **Setup**: Connect via Claude MCP connector — no API key management needed
+- **Scope**: All data is scoped to the authenticated organisation
+
+## Common Agent Operations
+
+All operations are performed via MCP tools. The following are the primary tool calls available.
+
+### Search Partners
+
+```
+search_partners
+  dateRange: { field: "CREATED_AT" | "LAST_ACTIVITY_AT", from: "YYYY-MM-DD", to: "YYYY-MM-DD" }
+```
+
+Returns: partner name/ID, contact info, tier, lifecycle stage, categories, country, last activity date.
+
+### Search CRM Objects (Deals, Tickets, Leads, Companies, Contacts)
+
+```
+search_crm_objects
+  objectType: "DEAL" | "TICKET" | "LEAD" | "COMPANY" | "CONTACT"
+  stage: "OPEN" | "WON" | "LOST"
+  view: "ALL" | "DUE" | "OVERDUE" | "INACTIVE"
+  rollingDateFilter: { field: "CLOSED_AT", value: "THIS_QUARTER" }
+  sortBy: { property: "AMOUNT", direction: "DESC" }
+  limit: 10
+```
+
+Synonym mapping: Opportunity/Forecast → `DEAL`, Account → `COMPANY`, Case → `TICKET`.
+
+### Search Tasks
+
+```
+search_tasks
+  status: "TODO" | "IN_PROGRESS" | "PENDING" | "COMPLETED" | "DONE"
+  partnerId: "{partner_id}"
+```
+
+### Search Commissions
+
+```
+search_commissions
+  partnerId: "{partner_id}"
+```
+
+Returns: commission amounts, currency, payment status, associated partner and deals.
+
+### Generate Business Review (QBR/MBR/WBR)
+
+```
+generate_business_review
+  duration: "QUARTERLY" | "MONTHLY" | "WEEKLY"
+  partnerId: "{partner_id}"
+```
+
+Returns: pipeline & forecast analysis, form submissions overview, mutual action plan, goal tracking, timed agenda and next steps.
+
+### Search Partner Engagement
+
+```
+search_partner_engagement
+  partnerId: "{partner_id}"
+  type: "ROOM_VISIT" | "OBJECT_SHARE" | "COMMENT" | "FORM_SUBMIT" | "TASK_CREATED" | ...
+  dateRange: { from: "YYYY-MM-DD", to: "YYYY-MM-DD" }
+```
+
+Returns: comments, deal updates, asset views, task events, portal visits, form submissions, announcements, quotes.
+
+### Add Comment to Deal/Object
+
+```
+add_comment
+  comment: "Comment text"
+  objectId: "{crm_object_id}"
+  objectType: "DEAL" | "TICKET" | "LEAD" | "COMPANY" | "CONTACT"
+```
+
+### Create or Update Tasks
+
+```
+add_task
+  name: "Task title"
+  dueDate: "2025-02-20"
+  assignedTo: "PARTNER" | "ORGANISATION"
+  partnerId: "{partner_id}"
+
+update_task
+  taskId: 123
+  status: "TODO" | "IN_PROGRESS" | "DONE"
+```
+
+### Update CRM Object Properties
+
+```
+update_crm_object
+  objectId: "{crm_object_id}"
+  objectType: "DEAL"
+  propertiesToUpdate: { "amount": 50000, "stage": "Negotiation" }
+```
+
+### Share Lead or Register Deal
+
+Two-step flow:
+1. **Discovery**: provide `objectType` and `callToAction` to get form fields
+2. **Submit**: provide `formId` and `userProvidedData` to submit
+
+```
+share_lead_or_register_deal
+  objectType: "Deal"
+  callToAction: "Register Deal"
+  partnerId: "{partner_id}"
+```
+
+## Key Metrics
+
+### Partner Data
+- `id` - Partner ID
+- `name` - Partner company name
+- `championEmail` - Primary contact email
+- `tier` - Current tier level
+- `lifecycleStage` - Partner lifecycle stage
+- `categories` - Partner categories
+- `country` - Partner country
+- `lastActivityAt` - Last activity date
+
+### CRM Object Data
+- `objectId` - External CRM ID
+- `objectType` - DEAL, TICKET, LEAD, COMPANY, CONTACT
+- `stage` - OPEN, WON, LOST
+- `amount` - Deal amount
+- `closeDate` - Expected close date
+
+### Commission Data
+- `amount` - Commission amount
+- `currency` - Payment currency
+- `paymentStatus` - Current payment status
+- `partnerId` - Associated partner
+- `dealId` - Associated deal
+
+### Engagement Data
+- `type` - Activity type (ROOM_VISIT, COMMENT, FORM_SUBMIT, etc.)
+- `partnerId` - Partner involved
+- `crmObjectId` - Related CRM object
+- `createdAt` - Activity timestamp
+
+## When to Use
+
+- Managing channel partner relationships and tracking partner activity
+- Reviewing partner-sourced pipeline (deals, leads, opportunities)
+- Preparing QBR/MBR/WBR meetings with automated business review generation
+- Tracking partner commissions and payouts
+- Managing mutual action plans via tasks assigned to partners or internal teams
+- Processing deal registrations and lead sharing from partners
+- Monitoring partner portal engagement and content asset views
+
+## Rate Limits
+
+- Rate limits managed by the MCP connector
+- All data scoped to authenticated organisation
+
+## Relevant Skills
+
+- revops
+- sales-enablement
+- referrals
+- competitors

package/departments/marketing/tools/integrations/keywords-everywhere.md

@@ -0,0 +1,207 @@
+# Keywords Everywhere
+
+Keyword research API for search volume, CPC, competition, related keywords, and traffic data.
+
+## Capabilities
+
+| Integration | Available | Notes |
+|-------------|-----------|-------|
+| API | ✓ | REST API for keyword data, related keywords, traffic |
+| MCP | - | Community MCP server available |
+| CLI | ✓ | [keywords-everywhere.js](../clis/keywords-everywhere.js) |
+| SDK | - | API-only |
+
+## Authentication
+
+- **Type**: API Key (Bearer token)
+- **Header**: `Authorization: Bearer {api_key}`
+- **Get key**: https://keywordseverywhere.com/first-install-addon.html
+- **Limit**: 100 keywords per request
+
+## Common Agent Operations
+
+### Get keyword data (volume, CPC, competition)
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_keyword_data
+
+Authorization: Bearer {api_key}
+
+{
+  "country": "us",
+  "currency": "USD",
+  "dataSource": "gkp",
+  "kw": ["email marketing", "marketing automation", "crm software"]
+}
+```
+
+### Get related keywords
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_related_keywords
+
+Authorization: Bearer {api_key}
+
+{
+  "country": "us",
+  "currency": "USD",
+  "dataSource": "gkp",
+  "kw": ["email marketing"]
+}
+```
+
+### Get "People Also Search For" keywords
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_pasf_keywords
+
+Authorization: Bearer {api_key}
+
+{
+  "country": "us",
+  "currency": "USD",
+  "dataSource": "gkp",
+  "kw": ["email marketing"]
+}
+```
+
+### Get domain keywords (what a domain ranks for)
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_domain_keywords
+
+Authorization: Bearer {api_key}
+
+{
+  "country": "us",
+  "currency": "USD",
+  "domain": "example.com"
+}
+```
+
+### Get URL keywords (what a specific URL ranks for)
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_url_keywords
+
+Authorization: Bearer {api_key}
+
+{
+  "country": "us",
+  "currency": "USD",
+  "url": "https://example.com/page"
+}
+```
+
+### Get domain traffic
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_domain_traffic
+
+Authorization: Bearer {api_key}
+
+{
+  "country": "us",
+  "domain": "example.com"
+}
+```
+
+### Get URL traffic
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_url_traffic
+
+Authorization: Bearer {api_key}
+
+{
+  "country": "us",
+  "url": "https://example.com/page"
+}
+```
+
+### Get domain backlinks
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_domain_backlinks
+
+Authorization: Bearer {api_key}
+
+{
+  "domain": "example.com"
+}
+```
+
+### Get page backlinks
+
+```bash
+POST https://api.keywordseverywhere.com/v1/get_page_backlinks
+
+Authorization: Bearer {api_key}
+
+{
+  "url": "https://example.com/page"
+}
+```
+
+### Check credits
+
+```bash
+GET https://api.keywordseverywhere.com/v1/get_credits
+
+Authorization: Bearer {api_key}
+```
+
+### Get supported countries
+
+```bash
+GET https://api.keywordseverywhere.com/v1/get_countries
+
+Authorization: Bearer {api_key}
+```
+
+### Get supported currencies
+
+```bash
+GET https://api.keywordseverywhere.com/v1/get_currencies
+
+Authorization: Bearer {api_key}
+```
+
+## Key Metrics
+
+### Keyword Data
+- `vol` - Monthly search volume
+- `cpc.value` - Cost per click
+- `competition` - Competition score
+- `trend` - 12-month trend data
+
+### Traffic Data
+- `estimated_traffic` - Estimated monthly traffic
+- `keywords_count` - Number of ranking keywords
+
+## Parameters
+
+- `country` - Country code (us, uk, de, fr, etc.)
+- `currency` - Currency code (USD, GBP, EUR, etc.)
+- `dataSource` - Data source, default `gkp` (Google Keyword Planner)
+- `kw` - Array of keywords (max 100 per request)
+
+## When to Use
+
+- Quick keyword research with volume and CPC
+- Finding related keywords and PASF suggestions
+- Analyzing domain/URL keyword rankings
+- Traffic estimation for domains and pages
+- Backlink discovery
+
+## Rate Limits
+
+- 100 keywords per request
+- Credit-based pricing (1 credit per keyword)
+
+## Relevant Skills
+
+- seo-audit
+- content-strategy
+- programmatic-seo
+- competitors