0.0.1 • Published 1 year ago

wbb-allpay v0.0.1

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

WBB Sample Public Integration Template

This project is a template for creating new integrations via cloud functions. The files should be modified as follows :

  • Update the package.json file
    • change the name. Please ensure everything is prefixed with wbb-
    • change the deploy-dev and deploy-prod tasks. Specifically change the deploy option from wbb-integration-template to something specific to the function. This again should be prefixed with wbb- for example wbb-mailchimp.
  • Update the README.md, see notes and instructions for the template below.
  • Create src/handlers/my-integration.ts - create a file to handle the integration, giving it an appropriate name. An example is provided in src/handlers/example.ts
  • Update src/handlers/index.ts - update the root file to reference the handlers that you've created.

Various functions exist in the src/util/validation.ts file that will help validate parameters required, as well as perform string substitution if required.

Development

  • run npm run watch to start building the code and watching for changes.
  • In a separate terminal run npm start to start the functions framework and make the code accessible via HTTP
  • Use ngrok to make the webserver public, ie ngrok http 8080.

Setup

Complete any setup instructions here.

Blocks Provided

Provide a list of the blocks provided as part of this integration. This should be a list of block name, and its description.

Handler Names

The following handler names and their functions are available :

Handler NamePurpose

Configuration Options

( Provide a list of the configuration options for each of the handlers mentioned above )

Within the function there are a number of options that can be set to configure the behaviour of the integration. The tables below show the settings that are available for each handler.

handler-one

PropertyRequiredDescription