📝 Updated parts of the documentation

panoratech · Jul 23, 2024 · bd27073 · bd27073
1 parent 799d0f1
commit bd27073
Show file tree

Hide file tree

Showing 30 changed files with 941 additions and 158 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,8 @@ Your customers expect all of their tools to work well together. Panora avoids yo
 
 Panora supports integration with the following objects across multiple platforms:
 
+[Here is an extensive list of all integrations !](https://docs.panora.dev/integrations-catalog)
+
 ### CRM
 
 |                                               | Contacts | Deals | Notes | Engagements | Tasks | Users | Companies |
@@ -90,7 +92,13 @@ Your favourite software is missing? [Ask the community to build a connector!](ht
   docker compose up
  ```
 
-Visit our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product
+Visit our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product !
+
+See also [our selfhost guide here !](https://docs.panora.dev/open-source/selfhost/self-host-guide)
+
+# 👾 Join the community
+
+- [Join the Discord](https://discord.com/invite/PH5k7gGubt)
 
 # 🤔 Questions? Ask the core team
 

diff --git a/docs/integrations-catalog.mdx b/docs/integrations-catalog.mdx
@@ -0,0 +1,18 @@
+---
+title: "Integration Catalog"
+description: ""
+icon: album-collection
+---
+
+<CardGroup cols={2}>
+  <Card title="ATS" href="/integrations/ats/index"  horizontal>
+  </Card>
+  <Card title="File Storage" href="/integrations/filestorage/index" horizontal>
+  </Card>
+  <Card title="CRM" href="/integrations/crm/index"  horizontal>
+  </Card>
+  <Card title="Ticketing" href="/integrations/ticketing/index"  horizontal>
+  </Card>
+  <Card title="Ecommerce" href="/integrations/ecommerce/index"  horizontal>
+  </Card>
+</CardGroup>
diff --git a/docs/integrations/ats/ashby/index.mdx b/docs/integrations/ats/ashby/index.mdx
@@ -0,0 +1,31 @@
+---
+title: "Ashby"
+description: ""
+---
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Activity     | Yes ✅ | /candidate.listNotes  |
+| Application      | Yes ✅  | [/application.create , /application.list]  |
+| Attachment   | Yes ✅ | [/candidate.uploadResume , /candidate.uploadFile ] | 
+| Candidate   | Yes ✅| [/candidate.create, /candidate.list]  | 
+| Department   | Yes ✅ | /departement.list  |
+| Eeocs   | No 🚫|   |
+| Interview   | Yes ✅| /interviewSchedule.list  | 
+| Job   | Yes ✅ | /job.list  |
+| Job Interview Stage   | Yes ✅| /interviewStage.list |
+| Offer   | Yes ✅| /offer.list |
+| Office   | Yes ✅| /location.list  |
+| Reject Reason   | Yes ✅| /archiveReason.list |
+| Score Card   | No 🚫|   |
+| Tag   | Yes ✅| /candidateTag.list  |
+| User   | Yes ✅| /user.list |
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     ||
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/ats/index.mdx b/docs/integrations/ats/index.mdx
@@ -1,10 +1,11 @@
 ---
-title: "Ats"
+title: "Providers"
 description: ""
+icon: crab
 ---
 
 <CardGroup cols={2}>
-  <Card title="Ashby" icon={
+  <Card title="Ashby" href="/integrations/ats/ashby/index" icon={
     <img src="https://images.ctfassets.net/p03bi75xct27/2tVvkghDdMJxzkMca2QLnr/31b520c5e07db0103948af171fb54e99/ashby_logo_square.jpeg?q=80&fm=webp&w=2048" />
   } horizontal>
   </Card>

diff --git a/docs/integrations/crm/attio/index.mdx b/docs/integrations/crm/attio/index.mdx
@@ -0,0 +1,25 @@
+---
+title: "Attio"
+description: ""
+--- 
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Contact     | Yes ✅ | [/objects/people/records , /objects/people/records/query] |
+| Company      | Yes ✅  | [/objects/companies/records , /objects/companies/records/query] |
+| Deal   | Yes ✅ | [/objects/deals/records , /objects/deals/records/query] | 
+| Engagement   | No 🚫| | 
+| Note   | Yes ✅ | /notes  |
+| Stage   | No 🚫|  |
+| Task   | Yes ✅| /tasks | 
+| User   | Yes ✅ | /workspace_members  |
+
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     | |
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/crm/close/index.mdx b/docs/integrations/crm/close/index.mdx
@@ -0,0 +1,25 @@
+---
+title: "Close" 
+description: ""
+---
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Contact     | Yes ✅ | /contact  |
+| Company      | Yes ✅  | /lead  |
+| Deal   | Yes ✅ | /opportunity | 
+| Engagement   | Yes ✅| [/activity/calls , /activity/meetings , /activity/emails] | 
+| Note   | Yes ✅ | /activity/note  |
+| Stage   | Yes ✅| /activity/status_change/opportunity/?opportunity_id=:remote_deal_id |
+| Task   | Yes ✅| /task | 
+| User   | Yes ✅ | /user  |
+
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     | |
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/crm/hubspot/index.mdx b/docs/integrations/crm/hubspot/index.mdx
@@ -0,0 +1,24 @@
+---
+title: "Hubspot"
+description: ""
+---
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Contact     | Yes ✅ | /objects/contacts  |
+| Company      | Yes ✅  | /objects/companies  |
+| Deal   | Yes ✅ | /objects/deals | 
+| Engagement   | Yes ✅| [/objects/calls , /objects/meetings , /objects/emails] | 
+| Note   | Yes ✅ | /objects/notes  |
+| Stage   | Yes ✅| /crm-pipelines/v1/pipelines/deals |
+| Task   | Yes ✅| /objects/tasks | 
+| User   | Yes ✅ | /owners  |
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     |crm.objects.companies.read crm.objects.companies.write crm.objects.contacts.read crm.objects.contacts.write crm.objects.deals.read crm.objects.deals.write crm.objects.custom.read crm.objects.custom.write crm.objects.leads.read crm.objects.leads.write crm.objects.owners.read crm.objects.users.read crm.objects.users.write oauth sales-email-read |
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/crm/index.mdx b/docs/integrations/crm/index.mdx
@@ -1,30 +1,31 @@
 ---
-title: "Crm"
+title: "Providers"
 description: ""
+icon: crab
 ---
 
 <CardGroup cols={2}>
-  <Card title="Hubspot" icon={
+  <Card title="Hubspot" href="/integrations/crm/hubspot/index" icon={
     <img src="https://assets-global.website-files.com/6421a177cdeeaf3c6791b745/64d61202dd99e63d40d446f6_hubspot%20logo.png" />
   } horizontal>
   </Card>
-  <Card title="Close" icon={
+  <Card title="Close" href="/integrations/crm/close/index"  icon={
         <img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTEH77yPBUkStmoc1ZtgJS4XeBmQiaq_Q1vgF5oerOGbg&s" />
   } horizontal>
   </Card>
-  <Card title="Attio" icon={
+  <Card title="Attio" href="/integrations/crm/attio/index" icon={
         <img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSJWZsShi0G6mZ451MngEvQrmJ2JIGH-AF8JyFU-q-n3w&s"  />
   } horizontal>
   </Card>
-  <Card title="Zoho" icon={
+  <Card title="Zoho" href="/integrations/crm/zoho/index"  icon={
         <img src="https://assets-global.website-files.com/64f68d43d25e5962af5f82dd/64f68d43d25e5962af5f9812_64ad8bbe47c78358489b29fc_645e3ccf636a8d659f320e25_Group%25252012.png"  />
   } horizontal>
   </Card>
-  <Card title="Pipedrive" icon={
+  <Card title="Pipedrive" href="/integrations/crm/pipedrive/index" icon={
         <img src="https://asset.brandfetch.io/idZG_U1qqs/ideqSFbb2E.jpeg"/>
   } horizontal>
   </Card>
-  <Card title="Zendesk" icon={
+  <Card title="Zendesk" href="/integrations/crm/zendesk/index" icon={
         <img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRNKVceZGVM7PbARp_2bjdOICUxlpS5B29UYlurvh6Z2Q&s"/>
   } horizontal>
   </Card>

diff --git a/docs/integrations/crm/pipedrive/index.mdx b/docs/integrations/crm/pipedrive/index.mdx
@@ -0,0 +1,25 @@
+---
+title: "Pipedrive"
+description: ""
+--- 
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Contact     | Yes ✅ | /persons  |
+| Company      | Yes ✅  | /organizations  |
+| Deal   | Yes ✅ | /deals | 
+| Engagement   | Yes ✅| /activities | 
+| Note   | Yes ✅ | /notes  |
+| Stage   | Yes ✅ | [/deals , /stages]  |
+| Task   | Yes ✅| [/activities?type=task , /activities] | 
+| User   | Yes ✅ | /users  |
+
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     | |
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/crm/zendesk/index.mdx b/docs/integrations/crm/zendesk/index.mdx
@@ -0,0 +1,25 @@
+---
+title: "Zendesk"
+description: ""
+--- 
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Contact     | Yes ✅ | /contacts |
+| Company      | Yes ✅  | /contacts  |
+| Deal   | Yes ✅ | /deals | 
+| Engagement   | Yes ✅| /calls | 
+| Note   | Yes ✅ | /notes  |
+| Stage   | Yes ✅ | [/stages , /deals/:remote_deal_id] |
+| Task   | Yes ✅| /tasks | 
+| User   | Yes ✅ | /users  |
+
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     ||
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/crm/zoho/index.mdx b/docs/integrations/crm/zoho/index.mdx
@@ -0,0 +1,25 @@
+---
+title: "Zoho"
+description: ""
+--- 
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Contact     | Yes ✅ | /Contacts  |
+| Company      | Yes ✅  | /Accounts  |
+| Deal   | Yes ✅ | /Deals | 
+| Engagement   | Yes ✅| [/Calls , /Events] | 
+| Note   | Yes ✅ | [/Notes, /Notes/:remote_note_id, ]  |
+| Stage   | No 🚫|  |
+| Task   | Yes ✅| /Tasks | 
+| User   | Yes ✅ | /users?type=AllUsers  |
+
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     |ZohoCRM.modules.ALL,ZohoCRM.users.READ |
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/ecommerce/index.mdx b/docs/integrations/ecommerce/index.mdx
@@ -1,10 +1,11 @@
 ---
-title: "Ecommerce"
+title: "Providers"
 description: ""
+icon: crab
 ---
 
 <CardGroup cols={2}>
-  <Card title="Shopify" icon={
+  <Card title="Shopify" href="/integrations/ecommerce/shopify/index" icon={
     <img src="https://cdn.freebiesupply.com/logos/large/2x/shopify-logo-png-transparent.png" />
   } horizontal>
   </Card>

diff --git a/docs/integrations/ecommerce/shopify/index.mdx b/docs/integrations/ecommerce/shopify/index.mdx
@@ -0,0 +1,21 @@
+---
+title: "Shopify"
+description: ""
+---
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Customer     | Yes ✅ | /admin/api/2024-07/customers.json  |
+| Order      | Yes ✅  | /admin/api/2024-07/orders.json  |
+| Fulfillment   | Yes ✅ | /admin/api/2024-07/orders/:remote_order_id/fulfillments.json| 
+| Fulfillment Orders   | No 🚫|  | 
+| Product   | Yes ✅ | /admin/api/2024-07/products.json  |
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     |crm.objects.companies.read crm.objects.companies.write crm.objects.contacts.read crm.objects.contacts.write crm.objects.deals.read crm.objects.deals.write crm.objects.custom.read crm.objects.custom.write crm.objects.leads.read crm.objects.leads.write crm.objects.owners.read crm.objects.users.read crm.objects.users.write oauth sales-email-read |
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/filestorage/box/index.mdx b/docs/integrations/filestorage/box/index.mdx
@@ -0,0 +1,24 @@
+---
+title: "Box"
+description: ""
+---
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Drive     |No 🚫 |   |
+| File      | Yes ✅  | /folders/:remote_folder_id/items |
+| Folder   | Yes ✅ | [/folders, /folders/:remote_folder_id/items] | 
+| Group   | Yes ✅| /groups  | 
+| Permission   | No 🚫 | Coming Soon  |
+| Shared Link   | No 🚫|  Coming Soon | 
+| User   | Yes ✅ | /users  |
+
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     | |
+| Realtime webhook     | No 🚫|
diff --git a/docs/integrations/filestorage/index.mdx b/docs/integrations/filestorage/index.mdx
@@ -1,10 +1,11 @@
 ---
-title: "File Storage"
+title: "Providers"
 description: ""
+icon: crab
 ---
 
 <CardGroup cols={2}>
-  <Card title="Box" icon={
+  <Card title="Box" href="/integrations/filestorage/box/index" icon={
     <img src="https://gdm-catalog-fmapi-prod.imgix.net/ProductLogo/95b201e8-845a-4064-a9b2-a8eb49d19ca3.png?w=128&h=128&fit=max&dpr=3&auto=format&q=50" />
   } horizontal>
   </Card>

diff --git a/docs/integrations/ticketing/front/index.mdx b/docs/integrations/ticketing/front/index.mdx
@@ -0,0 +1,25 @@
+---
+title: "Front"
+description: ""
+---
+
+# Common Objects
+
+
+| Unified Model | Supported                           | Provider Endpoints                           |
+| -------- | ------------------------------------- | ------------------------------------- |
+| Account      | Yes ✅ | /accounts | 
+| Attachment      | No 🚫  | Coming Soon |
+| Collection   |No 🚫 |  | 
+| Comment   | Yes ✅| /conversations/:remote_ticket_id/comments  | 
+| Contact   | Yes ✅ | /contacts  |
+| Tag   | Yes ✅| /tags |
+| Team   | Yes ✅| /teams  | 
+| Ticket   | Yes ✅ | /conversations  |
+| User   | Yes ✅| /teammates|
+
+
+| Features | Supported                           |
+| -------- | ------------------------------------- |
+| Scopes     | |
+| Realtime webhook     | No 🚫|