-
Notifications
You must be signed in to change notification settings - Fork 195
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #157 from panoratech/docs-playground-testing
Docs playground testing
- Loading branch information
Showing
9 changed files
with
100 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: 'Contributing' | ||
description: 'We welcome all contributions to Panora; from small UI enhancements to brand new integrations. We love seeing community members level up and give people power-ups!' | ||
icon: 'star' | ||
--- | ||
|
||
<Frame caption="Our (Glorious) Contributors"> | ||
<img src="/images/contributors.gif" /> | ||
</Frame> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,46 @@ | ||
--- | ||
title: 'Magic Links' | ||
description: 'Invite your users to connect, without writing code' | ||
description: 'Use Magic Links to invite your users to grant you access to their data without a dedicated website. Create a full connection flow in just a few clicks. No code required.' | ||
icon: 'wand-magic-sparkles' | ||
--- | ||
|
||
## What is a magic link? | ||
<img | ||
className="block dark:hidden" | ||
src="/images/generate-magic-link.gif" | ||
alt="Hero Light" | ||
/> | ||
|
||
## Send your first Magic Link | ||
use CRM example | ||
|
||
## See linked users in your dashboard | ||
See we have a linked user id, etc | ||
<Steps> | ||
|
||
<Step> | ||
Login to your account dashboard | ||
</Step> | ||
|
||
<Step> | ||
Go to section Connections and local button `Create a Magic Link` | ||
</Step> | ||
|
||
<Step> | ||
Click `Create a Unique Magic Link` | ||
</Step> | ||
|
||
<Step> | ||
You'll be asked for two informations: an email and an `Origin User Identifier`. | ||
The `Origin User Identifier` is the id of the user you're inviting, as represented in your systems. | ||
</Step> | ||
|
||
<Step> | ||
Click Generate. You're now ready to share the link! | ||
</Step> | ||
|
||
</Steps> | ||
|
||
The connection will show as `status` until the user connects to a platform. | ||
We recommend listening to webhooks to get notified once a user connects. | ||
|
||
|
||
## Next: Make your first request using those new informations | ||
|
||
### Learn how to programmaticaly generate links | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
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` <br></br> 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` <br></br> 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` <br></br> 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` <br></br> Occurs when a new connection was created through a Magic Link. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters