Gathering detailed insights and metrics for convoy-app.js
Gathering detailed insights and metrics for convoy-app.js
Installations
npm install convoy-app.jsDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
14.21.3
NPM Version
6.14.18
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
1
Package Meta Information
Latest Version
0.2.8
Package Id
convoy-app.js@0.2.8
Unpacked Size
267.04 kB
Size
78.54 kB
File Count
26
NPM Version
6.14.18
Node Version
14.21.3
Published on
Sep 22, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Dev Dependencies
6
Convoy App Portal JS SDK
This SDK enables you to you to extend visibility from your Convoy dashboard to your customer platform, enabling them to view their subscriptions, create new subscriptions, view events and deliveries, debug event delivery requests and responses, replay events, e.t.c.
Below are examples of to get started.
Installation
You can install convoy-app.js by running the following command:
1npm i convoy-app.js
Or preferrably through a CDN from jsDelivr
https://cdn.jsdelivr.net/npm/convoy-app.js@0.2.8/dist/bundle.js
Usage
Convoy-app.js is compatible with all javascript frameworks and libraries. See instructions below.
Import/link convoy-app to project
1<script src="https://cdn.jsdelivr.net/npm/convoy-app.js@0.2.8/dist/bundle.js"></script>
Or
1import * as Convoy from 'convoy-app.js';
Or
1<script src="node_modules/convoy-app.js/dist/bundle.js"></script>
Now you need to initialize the convoy-app by providing your Convoy instance URL and app portal token (from your backend, reference here).
Javascript
1const convoy = new Convoy({ uri: 'convoy instance url', api_key: 'app token from your backend' });Typescript
1declare const Convoy: any;
2
3export class ConvoyExample {
4 convoy: any;
5
6 constructor() {
7 this.convoy = new Convoy({ uri: 'convoy instance url', api_key: 'app token from your backend' });
8 }
9}Now you can use convoy-app to render Convoy App Portal
1convoy.initAppPortal(); 2// You can optionally pass a DOM selector string, convoy-app uses #convoy-app by default 3convoy.initAppPortal('#convoy-app'); 4 5// You can also use convoy app to prompt user to create a subscription alone 6convoy.createSubscription(); 7// You can optionally pass a DOM selector string, convoy-app uses #convoy-create-sub by default 8convoy.createSubscription('#convoy-create-sub');
Lastly, you need to add the repective selector elements to your HTML
1<!-- For app portal --> 2<div id="convoy-app"></div> 3 4<!-- For create subscription modal --> 5<div id="convoy-create-sub"></div>
Complete examples
Vanilla Javascript
1<head> 2 <script src="https://cdn.jsdelivr.net/npm/convoy-app.js@0.2.8/dist/bundle.js"></script> 3 <!-- or --> 4 <script src="node_modules/convoy-app.js/dist/bundle.js"></script> 5</head> 6 7<body> 8 <!-- For app portal --> 9 <div id="convoy-app"></div> 10 11 <!-- For create subscription modal --> 12 <div id="convoy-create-sub"></div> 13 <body> 14 <script> 15 const convoy = new Convoy({ uri: 'convoy instance url', api_key: 'app token from your backend' }); 16 convoy.initAppPortal(); 17 convoy.createSubscription(); 18 </script> 19 </body> 20</body>
Typescript Project
1<head> 2 <script src="https://cdn.jsdelivr.net/npm/convoy-app.js@0.2.8/dist/bundle.js"></script> 3 <!-- or --> 4 <script src="node_modules/convoy-app.js/dist/bundle.js"></script> 5</head> 6 7<body> 8 <!-- For app portal --> 9 <div id="convoy-app"></div> 10 11 <!-- For create subscription modal --> 12 <div id="convoy-create-sub"></div> 13 <body></body> 14</body>
Your .ts file
1declare const Convoy: any;
2
3export class ConvoyExample {
4 convoy: any;
5
6 constructor() {
7 this.convoy = new Convoy({ uri: 'convoy instance url', api_key: 'app token from your backend' });
8
9 convoy.initAppPortal();
10 convoy.createSubscription();
11 }
12}Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.
No vulnerabilities found.
No security vulnerabilities found.