Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Create Notification component for WhatsApp Textmebot API #4316

Closed
1 task done
apilaura opened this issue Jan 3, 2024 · 6 comments
Closed
1 task done

Create Notification component for WhatsApp Textmebot API #4316

apilaura opened this issue Jan 3, 2024 · 6 comments
Labels
area:notifications Everything related to notifications help Stale

Comments

@apilaura
Copy link

apilaura commented Jan 3, 2024

⚠️ Please verify that this feature request has NOT been suggested before.

  • I checked and didn't find similar feature request

🏷️ Feature Request Type

New Notification

🔖 Feature description

I need help to create a new Notification component based on the Textmebot Whatsapp API. It is a simple web API to send WhatsApp Messages. I want to send the notifications via whatsapp using this API.
API url: https://textmebot.com

✔️ Solution

I want to send the notifications via WhatsApp using TextMeBot API.

Create a new Notification component that will capture two parameters:

  1. APIkey
  2. Recipient Phone number.

Then call to the web API using the apikey, phone number and the standard message.

The API has this format:
http://api.textmebot.com/send.php?recipient=<phone_number>&apikey=&text=<notification_message>

I can provide a free apikey and a $100 donation to the person who can help me.

❓ Alternatives

I have considered to modify some of the existing notification components and change the endpoint, parameters, etc... but I need help with the PR as I am not familiar with github methods.

📝 Additional Context

No response

@apilaura apilaura added the feature-request Request for new features to be added label Jan 3, 2024
@CommanderStorm CommanderStorm added help area:notifications Everything related to notifications and removed feature-request Request for new features to be added labels Jan 3, 2024
@CommanderStorm
Copy link
Collaborator

We currently don't support templating in the url field.
See #1734 for further details. (not because of technical reasons, we just have not gotten around to this part)

Adding WhatsApp is tracked in #1816

I am reading the website you linked, that you can request minor modifications via support@textmebot.com
I think allowing for text as a body is reasonable.

but I need help with the PR as I am not familiar with github methods

What part are you stuck on? Note that our contribution guide can be found here

@apilaura
Copy link
Author

apilaura commented Jan 4, 2024

The WhatsApp API already support POST requests and pass the parameters in the body.
Check here: https://documenter.getpostman.com/view/20714522/UzXLyxPD#8d96c754-fbe5-4a6b-b195-dc7ec2e473f1

Endpoint: https://api.textmebot.com/send.php
The POST body could contain:

{
"recipient":"+39xxxxxxxx",
"apikey":"my_apikey_yyyyyyy",
"text":"The monitoring alert here"
}

I will have a look at the contribution guide but basically I am completely new with github. I only know how to clone but have no experience with forks, branches, pull requests, commits, etc...

@CommanderStorm
Copy link
Collaborator

The WhatsApp API already support POST requests and pass the parameters in the body

Great, so you can use the webhook to post there via the templating already implemented.
No modification/PR needed.

I will have a look at the contribution guide

Honestly, I think using this provider for WhatsApp is not ideal. The official API is free for up to 1k Messages => using the API noted in #1816 is better from a contribution perspective

I am completely new with github

If you come across any problems, feel free to comment. We have all been there ^^

@andrealvess

This comment was marked as off-topic.

Copy link

github-actions bot commented Apr 6, 2024

We are clearing up our old help-issues and your issue has been open for 60 days with no activity.
If no comment is made and the stale label is not removed, this issue will be closed in 7 days.

@github-actions github-actions bot added the Stale label Apr 6, 2024
@CommanderStorm
Copy link
Collaborator

I am assuming this issue is resolved via the webhook notification provider.

FYI (for future readers):
We currently have 3 (2 of which to be released in v2.0) notification providers that support Whatsapp https://github.com/louislam/uptime-kuma/pulls?q=is%3Apr+Whatsapp

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
area:notifications Everything related to notifications help Stale
Projects
None yet
Development

No branches or pull requests

3 participants