WhatsAppIncomingWebhook WhatsAppIncomingWebhook

yaml
type: "io.kestra.plugin.notifications.whatsapp.WhatsAppIncomingWebhook"

Send a WhatsApp message using an Incoming Webhook

Add this task to a list of errors tasks to implement custom flow-level failure notifications. Check the WhatsApp documentation for more details..

Examples

Send a WhatsApp notification on a failed flow execution

yaml
id: unreliable_flow
namespace: company.team

tasks:
  - id: fail
    type: io.kestra.plugin.scripts.shell.Commands
    runner: PROCESS
    commands:
      - exit 1

errors:
  - id: alert_on_failure
    type: io.kestra.plugin.notifications.whatsapp.WhatsAppIncomingWebhook
    url: "{{ secret('WHATSAPP_WEBHOOK') }}" # https://webhook.your-domain
    payload: |
      {
        "profileName": "MyName",
        "whatsAppIds": ["IdNo1, IdNo2"],
        "from": 380999999999
      }

Send a WhatsApp message via incoming webhook

yaml
id: whatsapp_incoming_webhook
namespace: company.team

tasks:
  - id: send_whatsapp_message
    type: io.kestra.plugin.notifications.whatsapp.WhatsAppIncomingWebhook
    url: "{{ secret('WHATSAPP_WEBHOOK') }}"
    payload: |
      {
        "profileName": "MyName",
        "whatsAppIds": ["IdNo1, IdNo2"],
        "from": 380999999999,
        "messageId": "wamIdNo1"
      }

Properties

url

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Webhook URL which should be taken from whatsapp integrations tab

options

Options

The options to set to customize the HTTP client

payload

  • Type: string
  • Dynamic: ✔️
  • Required:

WhatsApp message payload

Definitions

java.nio.charset.Charset

Properties

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

Properties

connectTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required:
connectionPoolIdleTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required:
defaultCharset
  • Type:
  • Dynamic: ✔️
  • Required:
maxContentLength
  • Type:
    • integer
    • string
  • Dynamic: ✔️
  • Required:
readIdleTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required:
readTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required:

Was this page helpful?