WhatsAppExecution
WhatsAppExecution
type: "io.kestra.plugin.notifications.whatsapp.WhatsAppExecution"
Send a WhatsApp message with the execution information.
The message will include a link to the execution page in the UI along with the execution ID, namespace, flow name, the start date, duration and the final status of the execution, and (if failed) the task that led to a failure.
Use this notification task only in a flow that has a Flow trigger. Don't use this notification task in errors
tasks. Instead, for errors
tasks, use the WhatsAppIncomingWebhook task.
Examples
Send a WhatsApp notification on a failed flow execution
id: failure_alert
namespace: company.team
tasks:
- id: send_alert
type: io.kestra.plugin.notifications.whatsapp.WhatsAppExecution
url: "{{ secret('WHATSAPP_WEBHOOK') }}"
profileName: "MyProfile"
from: 380999999999
whatsAppIds:
- "some waId"
- "waId No2"
executionId: "{{trigger.executionId}}"
triggers:
- id: failed_prod_workflows
type: io.kestra.plugin.core.trigger.Flow
conditions:
- type: io.kestra.plugin.core.condition.ExecutionStatusCondition
in:
- FAILED
- WARNING
- type: io.kestra.plugin.core.condition.ExecutionNamespaceCondition
namespace: prod
prefix: true
Properties
url
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Min length:
1
Webhook URL which should be taken from whatsapp integrations tab
customFields
- Type: object
- Dynamic: ✔️
- Required: ❌
Custom fields to be added on notification
customMessage
- Type: string
- Dynamic: ✔️
- Required: ❌
Custom message to be added on notification
executionId
- Type: string
- Dynamic: ✔️
- Required: ❌
- Default:
{{ execution.id }}
The execution id to use
Default is the current execution, change it to {{ trigger.executionId }} if you use this task with a Flow trigger to use the original execution.
from
- Type: string
- Dynamic: ✔️
- Required: ❌
WhatsApp ID of the sender (Phone number)
messageId
- Type: string
- Dynamic: ✔️
- Required: ❌
Message id
payload
- Type: string
- Dynamic: ✔️
- Required: ❌
WhatsApp message payload
profileName
- Type: string
- Dynamic: ✔️
- Required: ❌
Sender profile name
recipientId
- Type: string
- Dynamic: ✔️
- Required: ❌
WhatsApp recipient ID
templateRenderMap
- Type: object
- Dynamic: ✔️
- Required: ❌
Map of variables to use for the message template
textBody
- Type: string
- Dynamic: ✔️
- Required: ❌
Message
whatsAppIds
- Type: array
- SubType: string
- Dynamic: ❌
- Required: ❌
The WhatsApp ID of the contact
Outputs
Definitions
Was this page helpful?