Meta WhatsAppIncomingWebhook

Meta WhatsAppIncomingWebhook

Certified

Send WhatsApp via incoming webhook

Posts a JSON payload to a WhatsApp on-prem incoming webhook. Works well in flow-level errors tasks for failure notifications.

yaml
type: io.kestra.plugin.meta.whatsapp.WhatsAppIncomingWebhook

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.meta.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.meta.whatsapp.WhatsAppIncomingWebhook
    url: "{{ secret('WHATSAPP_WEBHOOK') }}"
    payload: |
      {
        "profileName": "MyName",
        "whatsAppIds": ["IdNo1, IdNo2"],
        "from": 380999999999,
        "messageId": "wamIdNo1"
      }
Properties
Min length1

Incoming webhook URL

Webhook endpoint from the WhatsApp integration; supports expression rendering.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Options

The options to set to customize the HTTP client

Definitions
connectTimeoutstring

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutstring
DefaultPT0S

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

headersobject

HTTP headers

HTTP headers to include in the request

maxContentLengthintegerstring
Default10485760

The maximum content length of the response.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

readTimeoutstring
DefaultPT10S

The maximum time allowed for reading data from the server before failing.

WhatsApp message payload

Raw JSON payload sent to the webhook; include contacts/messages per WhatsApp on-prem format.