You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/app-portal.mdx
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ For more information on how to use the app portal please refer to the [receiving
23
23
App portal access is based on short-lived sessions using special magic links. You customers don't need a Svix account, and they don't even need to know that Svix exists.
24
24
:::
25
25
26
-
To give your users access to the [App Portal](./app-portal), just use the [app portal access endpoint](https://api.svix.com/docs#tag/Authentication/operation/v1.authentication.app-portal-access). Calling this endpoint with an `app_id` returns a single-use URL you can just redirect your users to in order to log them into the App Portal. They will stay logged in for a few days or until they log out.
26
+
To give your users access to the App Portal, just use the [app portal access endpoint](https://api.svix.com/docs#tag/Authentication/operation/v1.authentication.app-portal-access). Calling this endpoint with an `app_id` returns a single-use URL you can just redirect your users to in order to log them into the App Portal. They will stay logged in for a few days or until they log out.
## Implementing your own Consumer App Portal functionality
262
-
You can implement Consumer App Portal functionality into your own dashboard using ergonomic React Hooks provided by the `svix-react`library. This approach allows you to use your own UI structure and components. The hooks are an abstraction over the `svix` JavaScript library and help to handle concerns like paginating over large lists of data, and reloading data.
262
+
You can implement Consumer App Portal functionality into your own dashboard using ergonomic React Hooks provided by the [`svix-react`] library.
263
+
This approach allows you to use your own UI structure and components.
264
+
The hooks are an abstraction over the `svix` JavaScript library and help to handle concerns like paginating over large lists of data, and reloading data.
265
+
266
+
Using the hooks requires wrapping your application or components in`<SvixProvider>`:
263
267
264
-
Using the hooks requires wrapping your application or components in`<SvixProvider />`:
265
268
```jsx
266
269
import { SvixProvider } from 'svix-react'
267
270
@@ -274,7 +277,7 @@ export default function App() {
274
277
}
275
278
```
276
279
277
-
Then, you can use hooks like `useMessages`:
280
+
Then, you can use hooks like `useEndpoints`:
278
281
279
282
```jsx
280
283
import { useEndpoints } from 'svix-react'
@@ -302,7 +305,7 @@ export default function ListEndpoints() {
302
305
}
303
306
```
304
307
305
-
To get started and see a full list of hooks, refer to the [`svix-react`NPMpackage](https://www.npmjs.com/package/svix-react).
0 commit comments