Needling Perl Mongers

    serverless-plugin-telegram-webhook

    1.0.1 • Public • Published

    serverless-plugin-telegram-webhook

    Serverless plugin for automatically setting telegram webhook to lambda api gateway url on deploy.

    Install

    yarn add -D serverless-plugin-telegram-webhook
    # or
    npm install --save-dev serverless-plugin-telegram-webhook

    Add the following plugin to your serverless.yml:

    plugins:
      - serverless-plugin-telegram-webhook

    Configure

    Set the config in the self:custom of your serverless.yml file.

    Using reference to lambda

    custom:
      telegramWebhook:
        token: "my-telegram-bot-token"
        webhook:
          type: function
          value: webhookHandler # your lambda function identifier

    Using reference to api gateway path

    custom:
      telegramWebhook:
        token: "my-telegram-bot-token"
        webhook:
          type: path
          value: /webhook # your http api path

    Your serverless.yml should be similar to this:

    Using reference to lambda function

    service: serverless-example
    
    plugins:
      - serverless-plugin-telegram-webhook
    
    custom:
      telegramWebhook:
        token: my-telegram-bot-token
        webhook:
          type: function
          value: hello # reference to the hello lambda function
    
    provider:
      name: aws # this plugin currently only works with aws
    
    functions:
      hello:
        handler: handler.hello
        events:
          - http:
              path: hello
              method: get

    Using api gateway path

    service: serverless-example
    
    plugins:
      - serverless-plugin-telegram-webhook
    
    custom:
      telegramWebhook:
        token: my-telegram-bot-token
        webhook:
          type: path
          value: /hello
    
    provider:
      name: aws # this plugin currently only works with aws
    
    functions:
      hello:
        handler: handler.hello
        events:
          - http:
              path: hello
              method: get

    Contributing

    PRs are greatly appreciated, help us build this hugely needed tool so anyone else can easily build telegram bots using serverless framework.

    1. Create a fork
    2. Create your feature branch: git checkout -b my-feature
    3. Commit your changes: git commit -am 'add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request 🚀

    Install

    npm i serverless-plugin-telegram-webhook

    DownloadsWeekly Downloads

    5

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    17.5 kB

    Total Files

    7

    Last publish

    Collaborators

    • fuadop