Files
crewAI/docs/edge/ar/enterprise/integrations/hubspot.mdx
Lucas Gomide a237ebabba feat: adopt directory-based docs versioning with Edge channel (#6202)
* feat: adopt directory-based docs versioning with Edge channel

Switch docs.crewai.com from navigation-only versioning (every version
selector entry rendered the same docs/<lang>/* source files) to
Mintlify's directory-based versioning so each version selector entry
renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/*
that always reflects main HEAD for unreleased work, eliminating
pre-release leakage onto frozen release labels. External links to
canonical /<lang>/* URLs are preserved via wildcard redirects that
always land on the current default version.

Layout:
- docs/edge/<lang>/*         rolling source (you edit here)
- docs/edge/enterprise-api.*.yaml
- docs/v<X.Y.Z>/<lang>/*     frozen, immutable snapshots
- docs/v<X.Y.Z>/enterprise-api.*.yaml
- docs/images/               shared, append-only
- docs/docs.json             nav + redirects

URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for
Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard
redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links
working, and every freeze rewrites them (plus all per-section/per-page
redirects) so destinations always resolve to the current default
without depending on a second redirect hop.

Release flow integration (devtools release):
- New module crewai_devtools.docs_versioning.freeze() materialises
  docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the
  snapshot, inserts the version into every language block in
  docs.json, and refreshes all redirect destinations.
- _update_docs_and_create_pr() in cli.py now calls that freeze during
  Phase 2 of devtools release. Edge changelogs are updated first (so
  the snapshot freeze picks them up), then the snapshot is staged
  alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR
  is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z>
  — the title prefix the new CI guard reads.
- The PR still gates tag, GitHub release, PyPI publish, and the
  enterprise release as before; no new PRs are added.
- Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride
  Edge — and the docs PR title omits the [docs-freeze] prefix.
- docs_check (AI-generated docs scaffolding) writes to
  docs/edge/<lang>/* so newly-generated unreleased docs land in Edge
  and never accidentally touch a frozen snapshot.

Migration scripts (one-shot):
- scripts/docs/freeze_historical_versions.py reconstructs all 16
  historical snapshots (v1.10.0 .. v1.14.7) from git tags via
  git archive | tar, rewriting openapi: MDX refs so each snapshot
  reads its own enterprise-api YAML rather than the live one.
- scripts/docs/prefix_version_paths.py one-shot-migrates docs.json:
  rewrites every page path in 16 versioned blocks to point under
  docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags
  v1.14.7 as Latest (default), prunes pages whose target file
  doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before
  v1.12.0), and writes the wildcard + per-section redirects.
- scripts/docs/freeze_current_edge.py is now a thin CLI wrapper
  around docs_versioning.freeze for manual one-off freezes (e.g.
  retroactively snapshotting a forgotten release).

CI guards (.github/workflows/docs-snapshots.yml):
- Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose
  title contains [docs-freeze] (i.e. release-cut PRs generated by
  devtools release or the manual wrapper) may modify them.
- Images under docs/images/ are append-only since snapshots share a
  single image directory. Deleting or renaming an image breaks every
  historical snapshot that still references it.

Restored docs/images/crewai-otel-export.png from PR #3673; it was
deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference
it. Restoring instead of editing the snapshots preserves historical
rendering fidelity and validates the new append-only rule
retroactively.

Tests:
- lib/devtools/tests/test_docs_versioning.py covers the freeze: file
  copy, openapi rewrite, version insertion, default demotion, redirect
  upserts, per-section redirect rewriting, idempotency, and invalid
  inputs.

Verified locally with mintlify broken-links: 0 broken links across
the full site (Edge + 16 frozen versions, 4 locales).

AGENTS.md (repo root) is the contributor guide for the new model;
RELEASING.md is the release-cut runbook; README's Contribution
section links to both.

Co-authored-by: Cursor <cursoragent@cursor.com>

* style: resolve linter issues

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-17 11:56:59 -04:00

361 lines
14 KiB
Plaintext

---
title: تكامل HubSpot
description: "إدارة الشركات وجهات الاتصال في HubSpot مع CrewAI."
icon: "briefcase"
mode: "wide"
---
## نظرة عامة
مكّن وكلاءك من إدارة الشركات وجهات الاتصال داخل HubSpot. أنشئ سجلات جديدة وبسّط عمليات CRM باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
## المتطلبات الأساسية
قبل استخدام تكامل HubSpot، تأكد من توفر ما يلي:
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال.
- حساب HubSpot بالصلاحيات المناسبة.
- ربط حساب HubSpot الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors).
## إعداد تكامل HubSpot
### 1. ربط حساب HubSpot الخاص بك
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors).
2. ابحث عن **HubSpot** في قسم تكاملات المصادقة.
3. انقر على **Connect** وأكمل عملية OAuth.
4. امنح الصلاحيات اللازمة لإدارة الشركات وجهات الاتصال.
5. انسخ رمز المؤسسة من [إعدادات التكامل](https://app.crewai.com/crewai_plus/settings/integrations)
### 2. تثبيت الحزمة المطلوبة
```bash
uv add crewai-tools
```
### 3. إعداد متغير البيئة
<Note>
لاستخدام التكاملات مع `Agent(apps=[])`, يجب تعيين متغير البيئة
`CREWAI_PLATFORM_INTEGRATION_TOKEN` برمز المؤسسة الخاص بك.
</Note>
```bash
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
```
أو أضفه إلى ملف `.env`:
```
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
```
## الإجراءات المتاحة
<AccordionGroup>
<Accordion title="hubspot/create_company">
**الوصف:** إنشاء سجل شركة جديد في HubSpot.
**المعاملات:**
- `name` (string, مطلوب): اسم الشركة.
- `domain` (string, اختياري): اسم نطاق الشركة.
- `industry` (string, اختياري): القطاع.
- `phone` (string, اختياري): رقم الهاتف.
- `hubspot_owner_id` (string, اختياري): معرّف مالك الشركة.
- `type` (string, اختياري): نوع الشركة. القيم المتاحة: `PROSPECT`, `PARTNER`, `RESELLER`, `VENDOR`, `OTHER`.
- `city` (string, اختياري): المدينة.
- `state` (string, اختياري): الولاية/المنطقة.
- `zip` (string, اختياري): الرمز البريدي.
- `numberofemployees` (number, اختياري): عدد الموظفين.
- `annualrevenue` (number, اختياري): الإيرادات السنوية.
- `description` (string, اختياري): الوصف.
- `website` (string, اختياري): عنوان URL للموقع الإلكتروني.
</Accordion>
<Accordion title="hubspot/create_contact">
**الوصف:** إنشاء سجل جهة اتصال جديد في HubSpot.
**المعاملات:**
- `email` (string, مطلوب): عنوان البريد الإلكتروني لجهة الاتصال.
- `firstname` (string, اختياري): الاسم الأول.
- `lastname` (string, اختياري): اسم العائلة.
- `phone` (string, اختياري): رقم الهاتف.
- `hubspot_owner_id` (string, اختياري): مالك جهة الاتصال.
- `lifecyclestage` (string, اختياري): مرحلة دورة الحياة. القيم المتاحة: `subscriber`, `lead`, `marketingqualifiedlead`, `salesqualifiedlead`, `opportunity`, `customer`, `evangelist`, `other`.
- `company` (string, اختياري): اسم الشركة.
- `jobtitle` (string, اختياري): المسمى الوظيفي.
</Accordion>
<Accordion title="hubspot/create_deal">
**الوصف:** إنشاء سجل صفقة جديد في HubSpot.
**المعاملات:**
- `dealname` (string, مطلوب): اسم الصفقة.
- `amount` (number, اختياري): قيمة الصفقة.
- `dealstage` (string, اختياري): مرحلة مسار الصفقة.
- `pipeline` (string, اختياري): مسار المبيعات الذي تنتمي إليه الصفقة.
- `closedate` (string, اختياري): التاريخ المتوقع لإغلاق الصفقة.
- `hubspot_owner_id` (string, اختياري): مالك الصفقة.
- `dealtype` (string, اختياري): نوع الصفقة. القيم المتاحة: `newbusiness`, `existingbusiness`.
- `description` (string, اختياري): وصف الصفقة.
- `hs_priority` (string, اختياري): أولوية الصفقة. القيم المتاحة: `low`, `medium`, `high`.
</Accordion>
<Accordion title="hubspot/create_record_engagements">
**الوصف:** إنشاء تفاعل جديد (مثل ملاحظة، بريد إلكتروني، مكالمة، اجتماع، مهمة) في HubSpot.
**المعاملات:**
- `engagementType` (string, مطلوب): نوع التفاعل. القيم المتاحة: `NOTE`, `EMAIL`, `CALL`, `MEETING`, `TASK`.
- `hubspot_owner_id` (string, اختياري): المستخدم المعيّن للنشاط.
- `hs_timestamp` (string, اختياري): تاريخ ووقت النشاط.
- `hs_note_body` (string, اختياري): نص الملاحظة. (يُستخدم لـ `NOTE`)
- `hs_task_subject` (string, اختياري): عنوان المهمة. (يُستخدم لـ `TASK`)
- `hs_meeting_title` (string, اختياري): عنوان الاجتماع. (يُستخدم لـ `MEETING`)
</Accordion>
<Accordion title="hubspot/update_company">
**الوصف:** تحديث سجل شركة موجود في HubSpot.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف الشركة المراد تحديثها.
- `name` (string, اختياري): اسم الشركة.
- `domain` (string, اختياري): اسم نطاق الشركة.
- `industry` (string, اختياري): القطاع.
- `phone` (string, اختياري): رقم الهاتف.
- `description` (string, اختياري): الوصف.
</Accordion>
<Accordion title="hubspot/update_contact">
**الوصف:** تحديث سجل جهة اتصال موجود في HubSpot.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف جهة الاتصال المراد تحديثها.
- `firstname` (string, اختياري): الاسم الأول.
- `lastname` (string, اختياري): اسم العائلة.
- `email` (string, اختياري): عنوان البريد الإلكتروني.
- `phone` (string, اختياري): رقم الهاتف.
- `company` (string, اختياري): اسم الشركة.
- `jobtitle` (string, اختياري): المسمى الوظيفي.
</Accordion>
<Accordion title="hubspot/update_deal">
**الوصف:** تحديث سجل صفقة موجود في HubSpot.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف الصفقة المراد تحديثها.
- `dealname` (string, اختياري): اسم الصفقة.
- `amount` (number, اختياري): قيمة الصفقة.
- `dealstage` (string, اختياري): مرحلة مسار الصفقة.
- `closedate` (string, اختياري): تاريخ الإغلاق المتوقع.
</Accordion>
<Accordion title="hubspot/list_companies">
**الوصف:** الحصول على قائمة بسجلات الشركات من HubSpot.
**المعاملات:**
- `paginationParameters` (object, اختياري): استخدم `pageCursor` لجلب الصفحات اللاحقة.
</Accordion>
<Accordion title="hubspot/list_contacts">
**الوصف:** الحصول على قائمة بسجلات جهات الاتصال من HubSpot.
**المعاملات:**
- `paginationParameters` (object, اختياري): استخدم `pageCursor` لجلب الصفحات اللاحقة.
</Accordion>
<Accordion title="hubspot/list_deals">
**الوصف:** الحصول على قائمة بسجلات الصفقات من HubSpot.
**المعاملات:**
- `paginationParameters` (object, اختياري): استخدم `pageCursor` لجلب الصفحات اللاحقة.
</Accordion>
<Accordion title="hubspot/get_company">
**الوصف:** الحصول على سجل شركة واحد بواسطة معرّفه.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف الشركة المراد استرجاعها.
</Accordion>
<Accordion title="hubspot/get_contact">
**الوصف:** الحصول على سجل جهة اتصال واحد بواسطة معرّفه.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف جهة الاتصال المراد استرجاعها.
</Accordion>
<Accordion title="hubspot/get_deal">
**الوصف:** الحصول على سجل صفقة واحد بواسطة معرّفه.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف الصفقة المراد استرجاعها.
</Accordion>
<Accordion title="hubspot/search_companies">
**الوصف:** البحث عن سجلات الشركات في HubSpot باستخدام صيغة فلتر.
**المعاملات:**
- `filterFormula` (object, اختياري): فلتر بصيغة التعبير العادي المنفصل (OR لمجموعات AND).
- `paginationParameters` (object, اختياري): استخدم `pageCursor` لجلب الصفحات اللاحقة.
</Accordion>
<Accordion title="hubspot/search_contacts">
**الوصف:** البحث عن سجلات جهات الاتصال في HubSpot باستخدام صيغة فلتر.
**المعاملات:**
- `filterFormula` (object, اختياري): فلتر بصيغة التعبير العادي المنفصل (OR لمجموعات AND).
- `paginationParameters` (object, اختياري): استخدم `pageCursor` لجلب الصفحات اللاحقة.
</Accordion>
<Accordion title="hubspot/search_deals">
**الوصف:** البحث عن سجلات الصفقات في HubSpot باستخدام صيغة فلتر.
**المعاملات:**
- `filterFormula` (object, اختياري): فلتر بصيغة التعبير العادي المنفصل (OR لمجموعات AND).
- `paginationParameters` (object, اختياري): استخدم `pageCursor` لجلب الصفحات اللاحقة.
</Accordion>
<Accordion title="hubspot/delete_record_companies">
**الوصف:** حذف سجل شركة بواسطة معرّفه.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف الشركة المراد حذفها.
</Accordion>
<Accordion title="hubspot/delete_record_contacts">
**الوصف:** حذف سجل جهة اتصال بواسطة معرّفه.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف جهة الاتصال المراد حذفها.
</Accordion>
<Accordion title="hubspot/delete_record_deals">
**الوصف:** حذف سجل صفقة بواسطة معرّفه.
**المعاملات:**
- `recordId` (string, مطلوب): معرّف الصفقة المراد حذفها.
</Accordion>
<Accordion title="hubspot/describe_action_schema">
**الوصف:** الحصول على المخطط المتوقع لنوع كائن وعملية معينة.
**المعاملات:**
- `recordType` (string, مطلوب): معرّف نوع الكائن (مثال: 'companies').
- `operation` (string, مطلوب): نوع العملية (مثال: 'CREATE_RECORD').
</Accordion>
</AccordionGroup>
## أمثلة الاستخدام
### إعداد Agent أساسي لـ HubSpot
```python
from crewai import Agent, Task, Crew
# Create an agent with HubSpot capabilities
hubspot_agent = Agent(
role="CRM Manager",
goal="Manage company and contact records in HubSpot",
backstory="An AI assistant specialized in CRM management.",
apps=['hubspot'] # All HubSpot actions will be available
)
# Task to create a new company
create_company_task = Task(
description="Create a new company in HubSpot with name 'Innovate Corp' and domain 'innovatecorp.com'.",
agent=hubspot_agent,
expected_output="Company created successfully with confirmation"
)
# Run the task
crew = Crew(
agents=[hubspot_agent],
tasks=[create_company_task]
)
crew.kickoff()
```
### تصفية أدوات HubSpot المحددة
```python
from crewai import Agent, Task, Crew
# Create agent with specific HubSpot actions only
contact_creator = Agent(
role="Contact Creator",
goal="Create new contacts in HubSpot",
backstory="An AI assistant that focuses on creating new contact entries in the CRM.",
apps=['hubspot/create_contact'] # Only contact creation action
)
# Task to create a contact
create_contact = Task(
description="Create a new contact for 'John Doe' with email 'john.doe@example.com'.",
agent=contact_creator,
expected_output="Contact created successfully in HubSpot."
)
crew = Crew(
agents=[contact_creator],
tasks=[create_contact]
)
crew.kickoff()
```
### إدارة جهات الاتصال
```python
from crewai import Agent, Task, Crew
# Create agent with HubSpot contact management capabilities
crm_manager = Agent(
role="CRM Manager",
goal="Manage and organize HubSpot contacts efficiently.",
backstory="An experienced CRM manager who maintains an organized contact database.",
apps=['hubspot'] # All HubSpot actions including contact management
)
# Task to manage contacts
contact_task = Task(
description="Create a new contact for 'Jane Smith' at 'Global Tech Inc.' with email 'jane.smith@globaltech.com'.",
agent=crm_manager,
expected_output="Contact database updated with the new contact."
)
crew = Crew(
agents=[crm_manager],
tasks=[contact_task]
)
crew.kickoff()
```
### الحصول على المساعدة
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
تواصل مع فريق الدعم للحصول على المساعدة في إعداد تكامل HubSpot أو
استكشاف الأخطاء وإصلاحها.
</Card>