{"_id":"convoy.js","_rev":"11-a9d0b00a666e337e3c24f42e61eab92d","time":{"created":"2022-03-11T17:30:32.413Z","0.1.0":"2022-03-10T16:56:12.308Z","modified":"2023-11-13T14:52:10.713Z","0.1.1":"2022-03-11T17:30:32.563Z","0.1.2":"2022-03-14T16:50:37.572Z","0.1.3":"2022-09-23T12:54:48.343Z","0.1.4":"2022-11-07T07:50:22.873Z","0.1.5":"2022-12-06T12:39:51.807Z","1.0.0":"2022-12-06T12:50:45.737Z","1.0.1":"2023-04-27T09:05:10.098Z","1.0.2":"2023-06-15T17:58:35.302Z","1.1.0":"2023-11-13T14:52:10.552Z"},"name":"convoy.js","dist-tags":{"latest":"1.1.0"},"versions":{"0.1.1":{"name":"convoy.js","version":"0.1.1","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"0f7278fa3ae35f55c7c178288da93dcde554f9f4","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@0.1.1","_nodeVersion":"14.19.0","_npmVersion":"6.14.16","dist":{"integrity":"sha512-8YR/X0pTqyVX92L/gyXZyQOn34gcAdS3XtLuDyGisK0fDjFfNJO1Ca0eysNoJb0iyF52kO7gGQacvBVFiDxQyQ==","shasum":"2dc39b9a0ddbc42abffdda6fec03f4c18e1f4ff5","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-0.1.1.tgz","fileCount":35,"unpackedSize":60065,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiK4c4ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoVmhAAlUwXNXjlmVYC7/T/ralNM+l0NwFg4cwYmLhX8VRxnUySx9yO\r\noqVd9XzITQ/gWVXoA4U1uIU3+yjnnZZA506O16JnmGdt3PDic8BsnS6O10iS\r\nDMFrA03CAG72vigNyR279KD1wU17efmHAYnKJxKq4yvlC2uRazT+ozEXP3+M\r\nRNvjonIKgTko63Va8U3hUZh0+LJniyMAGR43BZJ81MnSkF8RRGSwxhNueb88\r\nyAUOZZoxrjjTBNarlldVEIw1zrxHGYrIe7fWQlyDdL88sbl4WClkR++yEQIA\r\npTHuwFVjX4u5W99CWxktaUmp0cLbIP0zEl6qPGR/2OcGBQuItWBH4TLWgafj\r\nqQ4460kn0Xf1y8O/mQDpTVUItUWqWNTUiMZyhp25CN8mCAnpDD7zDH5I+4sA\r\nR9loJ6x1rHk+0gF63kr/iZEvi5wRBO5uB6IgTG9zq5BbazcFDymhVohhhxtx\r\ngsBBgHKK9lp012LLJgUJZjW/Q9eAqtOhx4CvO7pxbGoNIYmd12LeP3v/HHiz\r\nkn3ue2W4EGungxla8Y0+6iYfdhC3vUfAhBFos6Z+CJ/osWs/daBQ3XjMlwYL\r\nM/jwhjVJDete/vcqKOrsSQWhPmzE6Lb4ufF8fDV6LbDgiEEeGUhR3ijd8Hea\r\n9WRaWSp3A+XgeJ4mEgbDsN/g8nFLxdUbW7o=\r\n=CJiY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIC36ir+WxmZFKwrcPeQJ1GlCTrizbBzYzT4pxrzFKyWXAiA7avG6T/eg4qOS3wMNQE9zc5Hq+RT9lDdhDvhpbw7KQw=="}]},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_0.1.1_1647019832413_0.6588730700411178"},"_hasShrinkwrap":false},"0.1.2":{"name":"convoy.js","version":"0.1.2","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"6f78d46149bd1cbace4e0160fca8c1cf675ddedc","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@0.1.2","_nodeVersion":"14.19.0","_npmVersion":"6.14.16","dist":{"integrity":"sha512-8L3p+OavyWf5KTX7hVgbfXdELcfPZUQd66WKMRj3MpBwlKaAuH/ij56ZKKq7bpkZveqUOUqTspXtcDSHTWjXWw==","shasum":"3c64fe5182e0b24a8166ac4d3ba57d0b673b7893","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-0.1.2.tgz","fileCount":35,"unpackedSize":60044,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiL3JdACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpKug/+NhooWlbBrvjrZ/YcQ9fo43Oawm7fFTvz4+BwEbudUWxI1EvU\r\nOPPzR2GGgHcQhQIVJsQMPErdtbgISzfI/hilOKplrlrITvSIrgndqPQn9Pex\r\nj6Z5Qb0D18u1O0BNmeQdmGbG/Z1NbWFKJ18GR7zDjievjJDmyh/C9DzftOiQ\r\nBTajhMJLIZ4u7qFt62SlksXvEOaPZZ9Pv/KF2op3r2i6hXDTWcs5XEz1EUth\r\naLbG0PhsxfHoK60F3g+4CY/mFu4OFgyWjXbU7h/ab0dSBj7qzZDOp6KxJoeG\r\n2OWgIv0pzgzlKgG42nz1ioXq8pmT43vdq8Py9O2JGxJj7se7ivUsLiit3XQz\r\nT6d23uIzYRfYqVYnKInqvWbaMsVKeJJNh4/ParYxdC8jYN87Y4wp8BrKbKwQ\r\nCG8Fkbcfj4mNg2qvMkXtZJxLQ3mWcJBBUcIRms2cz6DAgoqSHk30+PvRJBK3\r\nIKloJKfjLNzrkmD5r/1NfresWIf5iH/CQlYtneeyXekISZf0nWLeFuIl+r4/\r\nzv4m9jo+VuXUTBJQ/zOtKBBTlernLhE4CyFyJufJeF6MjkHzKLlLlIUMDtUR\r\nypBK0UDN3+94DQB5blyqFdwcFI82+Y7bxiXuQI2S5JmXrURhON6OpgJJzPNt\r\nWPyAv0jENnS1g/KE/ukqgBldZTFXcJp6NAc=\r\n=Z5ci\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCef1c3MsnCLNEQHYz+F2OSSgL9R6rT6QY3VQisE64P5gIgZQZtALiWs/LeUi4/AwwPkzEqIQW6qGD7u3ho3eFY/6Q="}]},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_0.1.2_1647276637346_0.8708827521287472"},"_hasShrinkwrap":false},"0.1.3":{"name":"convoy.js","version":"0.1.3","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"84a8febdbf858368867deca93363b6836a44e6d3","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@0.1.3","_nodeVersion":"14.20.0","_npmVersion":"6.14.17","dist":{"integrity":"sha512-vf3+2ff9h32Wf+tJTR4Sy62hJag70Qs+1KM31LEY+cIvpefXRONieCOuRk7qSe/J0efHrkjHuZFW+IfaEx/F3Q==","shasum":"33035d10e9a886ff80970cf7599f78b2357f486b","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-0.1.3.tgz","fileCount":43,"unpackedSize":76378,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDlsLzd/tfO4xfuJd5HzDlIhgqKEJ9t8moSNBBV8RkKxwIhAMvfVSZnpruwn/uoG/Nc/9huNPB4BKhgwTAzDXpa8rC2"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjLayYACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpAcQ//dRtrROdz5B+Sz9vELjSYrpu6BBuCI9qP5yltlbSjnDc/Mk+N\r\nA56XuveRHdll1tAhyrsNBObHwrExoMjG4dM0wbm4gyuMw8/fvBET7xvu5IEb\r\nI6IOb/6dolHhmdPapdFQDZjzhJKTcUzZyt2mZOazuBO1DeyxhcDAb5I8Fs82\r\nKmhgN9qqsY+HPGgfFrQRHqPGXRyLzdKpcnLS6uAJwSHFKuell3KTGa627R82\r\nj/tgy7onlzSw/sidrK/iKvJGM0EjEME67BOznnJk3QncVVj4L7abPNrzFith\r\nvrP9uwPRA9U1+klRVyWzZqkZ1XGZiCMOJxasfjPdbFcDgqOx4wQh5aJLwQlz\r\nzZ5uHbGOKzbm90DlFlhBAWwzoaYbUsEhfU8EA/voIlynCjo7bWUTojejuWTi\r\nGiFB0T6KfdDyX5aEq1JpyRK8fvKcIzi3LZgjSPqFJQI2GW6Lf7/7zAlPY4/i\r\nVXVatV/gGuAsfcnyurFzKuMmV8gruWKDQBnKbhf8WsfweUUCqpkiKU96f5IY\r\n2cjVM8x5gjqeAx2atJnlyn8JjeDC9Su2h2QSGsQTgrMLChp86AnE6eeLvRXk\r\nT68upkj3814zuf1M/DzoTnJ1bhgyVli5jRY19gsOaD5na6wncibw4FoJN2Ql\r\n6qvczu3H2Y+Jv6Aw00CZK8nvrdhzvhDmktM=\r\n=VN+c\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_0.1.3_1663937688147_0.9825177601428319"},"_hasShrinkwrap":false},"0.1.4":{"name":"convoy.js","version":"0.1.4","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"2ffdd90a85317216f55097139bb8739f4d2412fc","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@0.1.4","_nodeVersion":"14.20.1","_npmVersion":"6.14.17","dist":{"integrity":"sha512-D1g4IcTWij93A8dhRCsky29lpBpNy44tQpGYSau7ZbUCzYokbPz+mzENyc5ShwwvwVzqyD454aX+/8bvaeXoaA==","shasum":"2ed437aa06da04bd9db7920aec7a9c3947b7aa83","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-0.1.4.tgz","fileCount":45,"unpackedSize":81623,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCp6XeVdDNmJqJwNMxfu6xQ03WgNjCzDhL01bQANYGhBwIgaheSe6isM3QEp6wCODmFrNKvdf4fqqQoz5doC3AidAo="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjaLi+ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpuOxAAo/vcDGGrBaESMWv1D3Oahiq/uSr/igy30Mu/geuXL0bfhYs3\r\nv8B31UyddvEm2sVJtfyyV2FRYwat7Okg+LOQhKtNvn65EvPQffOc13rTBK7S\r\neapIcslRXmis9UemFgsXJ86kh/zAXmNn0SHRVFQAa/7h/b7EY42OciIH5r3K\r\nTmlcgwzvKQm6Ng55crqWWRzfRQz+izDRNEmfhLmLqtl2V3NWY4C5sSprOEzh\r\n4tZuyY9xQti0Z2pvzD+kxQGCuCXY/v8AQKWzoZnGAMSNVR2rqUlGVQxUtrlX\r\nva0ph/blshUUVz15wqmzNLzQwZtG0v0PptEcwQdJpTzYfza515uBBaJYO9NH\r\nUr3WKjadGVw41LW7MY5pP13eTW/XHFM6hYHOPTpYJ591CTVc4TJg6vcIhsJ5\r\njwbzjLXDv94sJybmPlgAjc4sHR818ts89Hb00E9H874la6M4ImnXWUaNrJzH\r\nUNzcepQijUrHHBS5XO6wN+n1OenntEVNC9uJaMZdabc8A133VxCl/qBphcjj\r\nEafvzF8mKwi5YtF+ebbQLUvnyxOmPqQtOVggsbupAgkkpUrcghRxfn5leK07\r\nFkqnO0n2Sy5z6eWxIbI4Ltx1OCHgv2eL5KRzcAmDGb4tbr9R/xiAtIvw5Sj+\r\nmILnckuAXH8Ai6YlFPW8Q4nSX4BdtU920z4=\r\n=Y1H7\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_0.1.4_1667807422769_0.43077304277435524"},"_hasShrinkwrap":false},"0.1.5":{"name":"convoy.js","version":"0.1.5","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"2a3205edd056d4f601120185bab794401e0669e6","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@0.1.5","_nodeVersion":"14.21.1","_npmVersion":"6.14.17","dist":{"integrity":"sha512-NOdMbHnzmeh+Fq31bDXceeelWpitBmC9WsyonfF+ataF7cf/Wy7p679tzW1EX3JS2I0rS82Zcq/oF49rTLDxaQ==","shasum":"237190c16f80ac7b51536e3e81aafaa665e80fe8","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-0.1.5.tgz","fileCount":45,"unpackedSize":81933,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDfsXidlWtNdbZvdAtk74ujrM1FYrJB/rmH+Bi4/Y35OAiAnsuLoKvniGPiHDJpJPLRmh927u9TIsh3bfCU7RBFImQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjjzgXACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoknA/7BcJC6wrocTnD3Z3s2i6EMAN1VpeZncBX1tyrTM2SumXz0OsU\r\nPu4JMegLcjAvpMzmA1mc6JDhjqJo1TkGnM7slAFl5RHVteZ0efk/P3BImlgT\r\niB/5Bnsj5Lgoh4DQyKUn/olpbgotBsIAglgCGW65TslaQpe01bs8H5pyhVWf\r\ncsXkAzJdGJeeGGnc0c+Qe3mO+5NVC7WyHP9SwFkfBkerjVstlu9tDnS5UIXO\r\nieXlBQpPUOe7q9r1zxaWO6XR7/wZS33PrQXH/v6LXKIpM5DwqwFT5FS2egJb\r\nmW5h7kw0484vb5FGnPpcST805nT3tXyuZ4GWO5q4lKAPGr1/EOhoH0eyQjbR\r\nFBJkH5qMCgWiTDz0K9H+cSf3Yf6okoY5Ca0HaqOC1fZR3TQkF/nA0BV4+jVK\r\neywXA11RRRd4K1VoByxNoKoDTC+Vp/kqa8qLuCkTeP91Vfk3cpyyrvApkhqP\r\nVhXRNrK0YTkWUR/onI2vCidagCxL9urHoHaGxl3cTpnZGFOzT34tPPs8eZwF\r\nxDWHXU6A2hnhADgJUfLQ7EyTA+FRx4BHxpMj4mvl6PSnwaYeabHJx1IBGP+f\r\nIXJcM6oL95d8Tp2Q3vuO177Isi7kJbs/nOwj9moxCrnmOnSqjckJWydT9QWl\r\nMUNq6DWI4qGk1w8xCyyF0a8O57JGJPt29f0=\r\n=/8VH\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_0.1.5_1670330391596_0.23824348791488292"},"_hasShrinkwrap":false},"1.0.0":{"name":"convoy.js","version":"1.0.0","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"d18ab670eaa409fc3433894b334e9bfda6ec1f21","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@1.0.0","_nodeVersion":"14.21.1","_npmVersion":"6.14.17","dist":{"integrity":"sha512-D7fGJdDrP0XnQ2ilSI09LSWOMtuEyb8NdKosbpX7jl7zmz6Cjy31a5fNtJ2CH0FQFj9edjtpOkt9SluvCmWB7Q==","shasum":"b4173d0e302ff0db37b5ae5069b557af8c21b132","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-1.0.0.tgz","fileCount":45,"unpackedSize":78928,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDFDf6Gj10t8JZqTN6GkSIXy5hXZxF/DZxKh2RzRjDtwQIhAKIKSx1V18a0BlcTWl3fVGX/y9ATzrmaslM0ruoOlhdV"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjjzqlACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoBWQ//WdVBC5ifzVmKkObVqnKWCnqpbpHeOKlb5nr4MFQtLqa6B4y9\r\nEq1LDoOl3wK76Bsi8luqU9cxqhXCB8UG67W0cOSW9Rj5NucWd3GEy/52dwKx\r\n4Asiu9CpdvmgRqj3Cg+IDMboXn2WLjQyqC8g3LqmWoK1jSQau7qAgS26ox94\r\n+FB/l+71iBeLnDnUoC4UHFnmkK6d+ngUsabCs/h0OpYwQlmWwTw4LzRf2JBh\r\nMxAIEUbfHnkfzTXIJrzvNqtLyCF9VK6w7AkxWJEeze5fSlfz883GYJj8Oofa\r\nY9iMiHgi1gF2A+iYZFCUvzgBVcf+C0kXBgnfXr8EBa3bB/NuSLstYMgV8Dl9\r\nG0bHv03eTaUca8eib2D6P7Oqa5S0se5zcjlR6dRJqOUuDRNt9qXtR04muqDU\r\nXpVhync5kqR/ohmV3JZ5gkT67O3rfKv7ARKlv7BJUncaNvHexQXow+mp0oaX\r\nwthAXd45WlnTY9Ui0n3495HmI7YZ8JWytcWKwO0yl0elHnB4o82CsGri0gcz\r\n74QKfC5S4ewaxy7bE3T5CW8qME7DwWZmYPbFAdVFLkL6zp8QIibk48oPVb5W\r\ndAvMoKMLFBrjtKOU0HLhJP8zkfQ425Hwmfgv02xASiz1LIJ808nvtjaGQYu/\r\nCfPlobjOWC0l7eO85656o9rFDp5hsAROPWo=\r\n=t5GD\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_1.0.0_1670331045531_0.17854074846707624"},"_hasShrinkwrap":false},"1.0.1":{"name":"convoy.js","version":"1.0.1","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"e01419f7bd7276a98d92d64c457ef96c5be6101d","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@1.0.1","_nodeVersion":"14.21.3","_npmVersion":"6.14.18","dist":{"integrity":"sha512-uYeN419i6SXk+JrrJAhDb81nJI2XvwJ6oXQo/FrAkT0Ubd49Z7q7Ac95DAB2TE3x3VxF3YJi1YdWej/bZ33tyg==","shasum":"85bc5ca16b0ee9b6f9eb310779e700555f448459","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-1.0.1.tgz","fileCount":41,"unpackedSize":71037,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHo2JomFv3a3p0E/UthPv4LwT0W9bW3RnISqWtGFretTAiEA4jxDlYERla1F3MuHmv6s0eFyXIr0mgLW4Xt+sAx8mls="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkSjrGACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrX6w/+La1Za+j+0x+7YDkdSOAc9Ml2WIIjfc4cdrFLQt49t2P3dKak\r\nepFRMDA8e74IsnC2WMkVf20tU/2B7paSRKnlUGVVirWb6Vy7d8/2qA+Tk6rt\r\nPGEnlj7r4EbOt3fJgxe93mKkp633xlnt9USpKRSuzkKMWmS8tiBXS7e5rUCs\r\n3ZntzX8DZCq75vgS6d240NmdYDX1wOAc0q8tIqocerdaFGQATvIQLP8eBmMT\r\nxQHbZl/MaLd7+2uARY6oi59/prEDRuQn82IvVKRhjtczseBn26mqZNtIUJyj\r\nFzmhAbCZCsHqpfrmzu6wv4t15CvdqYciqo9pUc+JbsTnVS2dRCMkaVTxD8Bj\r\n92lp2w83xacDD76WdLryQL72B4OguDir4zaTxoFqNWztXflp4IoD1/jbEsNC\r\nSRNiUtLXa1Wfl9mOexuzcBKaSvpvFOhjBetnbdJJV8TTA+VBzXUje6Cdm/eZ\r\nj1mXT02nEUs1WhRcOVAIYQ7Q9beo1jitAnRMCyCoEB9RJwF9AYYjgel4Cg8l\r\nPt0O4hECmV2F8ve03IZYpmv4ArHxRVfLS3rxJjwSqmfiP3BjyWzerpvq0RIl\r\nIoESY/UvrQyZ7D2fNqR4B8UGgoFYJ8YRU1BAos3G0u/zdBO6qPRwp9nsxN6I\r\n9iDWyzGS/iN0gjlnkvrwbnKlr9Y1sjqoeRk=\r\n=TAqa\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_1.0.1_1682586309827_0.3034389621141964"},"_hasShrinkwrap":false},"1.0.2":{"name":"convoy.js","version":"1.0.2","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"axios":"^0.26.0","base-64":"^1.0.0","http-status":"^1.5.0"},"devDependencies":{"@types/base-64":"^1.0.0","@types/jest":"^27.4.1","@types/node":"^17.0.21","jest":"^27.5.1","prettier":"^2.5.1","ts-jest":"^27.1.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.6.2"},"gitHead":"0658680614b83858dfac37d7117ef51b007ec1e3","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@1.0.2","_nodeVersion":"14.21.3","_npmVersion":"6.14.18","dist":{"integrity":"sha512-/v/kIAg4f6OL7V0Ifduupal0kMrAP88X+5667bbpJP8ldTV++0MxRiHbwHf+nvHd6NZd5IJOJoZmVk3XIwKfqA==","shasum":"541dad644b7902c9dbbae6618eaf7d1f643d242c","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-1.0.2.tgz","fileCount":41,"unpackedSize":72109,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBa18e8Jch1vPnBmmQ75M/uVivyKTKB6SQdnyNMV8jOtAiEAtTELaKwv4PsQEHOBdIvwJbXpapE6dgrfThGmih75cHk="}]},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_1.0.2_1686851915076_0.6443611625492172"},"_hasShrinkwrap":false},"1.1.0":{"name":"convoy.js","version":"1.1.0","description":"Convoy JS SDK Library","main":"dist/convoy.js","scripts":{"test":"jest --config jestconfig.json","prepare":"npm run build","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json"},"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"keywords":["convoy","webhooks"],"author":{"name":"Convoy"},"license":"MIT","dependencies":{"@aws-sdk/client-sqs":"^3.449.0","axios":"^1.6.1","base-64":"^1.0.0","http-status":"^1.7.3","kafkajs":"^2.2.4"},"devDependencies":{"@types/base-64":"^1.0.2","@types/jest":"^29.5.8","@types/node":"^20.9.0","jest":"^29.7.0","prettier":"^3.1.0","ts-jest":"^29.1.1","tslint-config-prettier":"^1.18.0","typescript":"^5.2.2"},"gitHead":"f1a32078f2bc9155a4d2348dc0cbce48d05e9cdb","bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"homepage":"https://github.com/frain-dev/convoy.js#readme","_id":"convoy.js@1.1.0","_nodeVersion":"14.21.3","_npmVersion":"6.14.18","dist":{"integrity":"sha512-pP/DhnkluOGlQAXdsNoGQNdl9bbKNEj9Whm2AeK7+pgpD8LQFT2LmdDu9xdstYre6RLw5OSFQGzzdN76LQii7Q==","shasum":"a728bc24a2bc2c2a71b6d2d3488053413022d655","tarball":"https://registry.npmjs.org/convoy.js/-/convoy.js-1.1.0.tgz","fileCount":49,"unpackedSize":89856,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDlKdb9bgfaU4ra6rfGU2EQMc+6EQTZfkpLej91AgRI0AIgVRDS/5jhWiKE69wRZYkiWNuQf64o2ICBNYXGbC0E/x8="}]},"_npmUser":{"name":"dotunj","email":"dotunjolaosho@gmail.com"},"directories":{},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/convoy.js_1.1.0_1699887130330_0.9738995880401082"},"_hasShrinkwrap":false}},"maintainers":[{"name":"dotunj","email":"dotunjolaosho@gmail.com"}],"description":"Convoy JS SDK Library","homepage":"https://github.com/frain-dev/convoy.js#readme","keywords":["convoy","webhooks"],"repository":{"type":"git","url":"git+https://github.com/frain-dev/convoy.js.git"},"author":{"name":"Convoy"},"bugs":{"url":"https://github.com/frain-dev/convoy.js/issues"},"license":"MIT","readme":"# Convoy SDK for JS\n\nThis is the Convoy JS SDK. This SDK contains methods for easily interacting with Convoy's API. Below are examples to get you started. For additional examples, please see our official documentation at (https://convoy.readme.io/reference)\n\n\n## Installation\nInstall convoy.js\n\n```bash\nnpm install convoy.js\n```\n\n## Setup Client\nNext, require the `convoy` module and setup with your auth credentials.\n\n```js\n\n// HTTP Client which connects to Convoy Cloud\nconst { Convoy } = require('convoy.js');\nconst convoy = new Convoy({ api_key: 'your_api_key', project_id: 'your_project_id' })\n\n\n// HTTP Client which connects to a self hosted Convoy instance\nconst { Convoy } = require('convoy.js');\nconst convoy = new Convoy({ uri: \"http://your-host/api/v1\", api_key: 'your_api_key', project_id: 'your_project_id' })\n\n// Amazon SQS Client\nconst { Convoy } = require('convoy.js');\nconst convoy = new Convoy({ api_key: 'your_api_key', project_id: 'your_project_id', sqsOptions: {} })\n\n\n// Apache Kafka Client\nconst { Convoy } = require('convoy.js');\nconst convoy = new Convoy({ api_key: 'your_api_key', project_id: 'your_project_id', kafkaOptions: {} })\n```\n\n### Create an Endpoint\nAn endpoint represents a target URL to receive events.\n\n```js\nconst endpointData = {\n  name: 'Default Endpoint',\n  url: \"https://webhook.site/63baf442-bbf7-4d51-97e8-428ade404459\",\n  description: \"Default Endpoint\",\n  secret: \"endpoint-secret\",\n  events: [\"*\"]\n};\n\nconst response = await convoy.endpoints.create(endpointData);\n```\nStore the Endpoint ID, so you can use it in subsequent requests for creating subscriptions or sending events.\n\n### Creating Subscriptions\n```js \nconst subscription = await convoy.subscriptions.create({\n  endpoint_id: '01HD6PJBQ0WE842PZ3J8SHDC46',\n  name: 'Test Subscription',\n  type: 'api'\n});\n```\n\n### Sending an Event\nYou can send events to Convoy via HTTP or via any supported message broker. See [here](https://www.getconvoy.io/docs/manual/sources#Message%20Brokers) to see the list of supported brokers.\n\n```js\n// Send an event to a single endpoint.\nconst eventData = {\n  endpoint_id: endpointId, \n  event_type: \"payment.success\",\n  data: { \n    event: \"payment.success\",\n    data: {\n      status: \"Completed\",\n      description: \"Transaction Successful\",\n      userID: \"test_user_id808\",\n    }\n  }\n};\n\nconst response = await convoy.events.create(eventData);\n\n// Fanout an event to multiple endpoints.\nconst eventData = {\n  owner_id: \"some_unique_key\",\n  event_type: \"payment.success\",\n  data: {\n    event: \"payment.success\",\n    data: {\n      status: \"Completed\",\n      description: \"Transaction Successful\",\n      userID: \"test_user_id808\",\n    }\n  }\n};\n\nconst response = await convoy.events.createFanOutEvent(eventData);\n```\n\n**Note:** The body struct used above is the same used for the message brokers below.\n\n#### SQS\nThis library depends on [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) to configure the SQS client.\n```js\n// Send event to a single endpoint.\nconst data = await convoy.sqs.writeEvent({\n    endpoint_id: '01HCF8X23MWXCEWR3K3HB7KAY8',\n    event_type: '*',\n    data: {\n        event: \"payment.success\",\n        data: {\n            status: \"Completed\",\n            description: \"Transaction Successful\",\n            userID: \"test_user_id808\",\n        }\n    }\n});\n\n// Fanout an event to multiple endpoints.\nconst data = await convoy.sqs.writeEvent({\n    owner_id: 'some_unique_key',\n    event_type: '*',\n    data: {\n        event: \"payment.success\",\n        data: {\n            status: \"Completed\",\n            description: \"Transaction Successful\",\n            userID: \"test_user_id808\",\n        }\n    }\n});\n```\n\n#### Kafka\nThis library depends on [kafkajs](https://github.com/tulios/kafkajs) to configure the Kafka client.\n```js\n// Send event to a single endpoint.\nconst data = await convoy.kafka.writeEvent({\n  endpoint_id: '01HCF8X23MWXCEWR3K3HB7KAY8',\n  event_type: '*',\n  data: { \n    event: \"payment.success\",\n    data: {\n      status: \"Completed\", \n      description: \"Transaction Successful\",\n      userID: \"test_user_id808\",\n    }\n  }\n});\n\n// Fanout an event to multiple endpoints.\nconst data = await convoy.kafka.writeEvent({\n  owner_id: 'some_unique_key',\n  event_type: '*',\n  data: { \n    event: \"payment.success\",\n    data: {\n      status: \"Completed\",\n      description: \"Transaction Successful\",\n      userID: \"test_user_id808\",\n    }\n  }\n});\n```\n\n### Verifying Webhooks\nThis client supports verifying [simple](https://www.getconvoy.io/docs/manual/signatures#Simple%20signatures) and [advanced](https://www.getconvoy.io/docs/manual/signatures#Advanced%20signatures) webhook signatures.\n\n```js\n// verfiy a simple signature\nconst webhook = new Webhook({\n    header: '666060cbe1348bbc7ec98f4e93dda8eaaf11bbf283d6a2dd56e841b2ef12fcd465c846903f709942473e1442604798186746f04848702c44a773f80672de7b21',\n    payload: { email: 'test@gmail.com', first_name: 'test', last_name: 'test' },\n    secret: '8IX9njirDG',\n    hash: 'sha512',\n    encoding: 'hex',\n});\n\nwebhook.verify()\n\n// verfiy an advanced signature\nconst webhook = new Webhook({\n    header: 't=2048976161,v1=afdb90313acfa15a3fc425755ae651a204947710315bb2a90bccaa87fce88998,v1=fLBDCBUiX5iIs0L5zfNq45h23EkX1HAMpFF+2lHrnes=',\n    payload: { email: 'test@gmail.com' },\n    secret: '8IX9njirDG',\n    hash: 'sha256',\n    encoding: 'base64',\n});\n\nexpect(webhook.verify()).toBeTruthy();\n```\n\n## Testing\n\n```bash\nnpm run test\n```\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n\n## Credits\n\n- [Frain](https://github.com/frain-dev)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","readmeFilename":"README.md"}