From d4c8740a7622dc35d655c6eeee9c1dd664d76801 Mon Sep 17 00:00:00 2001 From: Rachid F <109089247+rflihxyz@users.noreply.github.com> Date: Thu, 14 Dec 2023 13:52:20 +0000 Subject: [PATCH] :memo: Improve docs Improve docs --- docs/mint.json | 2 +- docs/webhooks/event-types.mdx | 13 ++++--------- docs/welcome.mdx | 4 +++- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/docs/mint.json b/docs/mint.json index 144c54a74..5b2fdd67b 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -11,7 +11,7 @@ }, "raiseIssue": true, "api": { - "baseUrl": "https://api-dev.panora.dev", + "baseUrl": "https://api-demo.panora.dev", "auth": { "method": "key" } diff --git a/docs/webhooks/event-types.mdx b/docs/webhooks/event-types.mdx index 10adcf199..1a9b82428 100644 --- a/docs/webhooks/event-types.mdx +++ b/docs/webhooks/event-types.mdx @@ -3,18 +3,13 @@ title: 'Event Types' description: '.' icon: 'wand-magic-sparkles' --- - -Types of events This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist. You’ll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against. Events that occur on subresources like customer.subscription do not trigger the parent’s update event. -Events marked as Selection required are only created when a webhook has been configured to listen for that type of event specifically. A webhook set to listen to all events will not receive an event requiring explicit selection. - - | Events | |--------------------------------------------------------------------------------------| -| `crm.contact.created`

Occurs whenever a new contact was created in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object| -| `crm.contact.updated`

Occurs whenever a new contact was updated in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object | -| `crm.contact.deleted`

Occurs whenever a new contact was deleted in a CRM. Sent only if the contact wasn't created using Panora. The `data` field is a `CRM` `Contact` object | -| `magic_link.connected`

Occurs when a new connection was created through a Magic Link. | +| **crm.contact.created**

Occurs whenever a new contactclear was created in a CRM. The `data` field is a `CRM` `Contact` object| +| **crm.contact.updated**

Occurs whenever a new contact was updated in a CRM. The `data` field is a `CRM` `Contact` object | +| **crm.contact.deleted**

Occurs whenever a new contact was deleted in a CRM. The `data` field is a `CRM` `Contact` object | +| **magic_link.connected**

Occurs when a new connection was created through a Magic Link. | \ No newline at end of file diff --git a/docs/welcome.mdx b/docs/welcome.mdx index a404e7dc0..198c8ae49 100644 --- a/docs/welcome.mdx +++ b/docs/welcome.mdx @@ -64,4 +64,6 @@ Your customers expect all of their tools to work well together. Panora avoids yo -[✏️ Suggest an update](https://tally.so/r/mRD1QQ?feedback_source=welcome) \ No newline at end of file +[✏️ Suggest an update](https://tally.so/r/mRD1QQ?feedback_source=welcome) + +