Send a Twilio message using a notification API.

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

yaml
type: "io.kestra.plugin.notifications.twilio.twilioalert"

Examples

Send a Twilio 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.twilio.TwilioAlert
    url: "{{ secret('TWILIO_NOTIFICATION_URL') }}" # https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Notifications
    accountSID: "{{ secret('TWILIO_ACCOUNT_SID') }}"
    authToken: "{{ secret('TWILIO_AUTH_TOKEN') }}"
    payload: |
      {
        "identity": "0000001"
      }

Send a Twilio message via incoming notification API.

yaml
id: twilio_alert
namespace: company.team

tasks:
  - id: send_twilio_message
    type: io.kestra.plugin.notifications.twilio.TwilioAlert
    url: "{{ secret('TWILIO_NOTIFICATION_URL') }}"
    accountSID: "{{ secret('TWILIO_ACCOUNT_SID') }}"
    authToken: "{{ secret('TWILIO_AUTH_TOKEN') }}"
    payload: |
      {
        "identity": "0000001"
      }

Properties

accountSID *string

Min length 1

Twilio account SID

authToken *string

Min length 1

Twilio authentication token

url *string

Min length 1

Twilio notification URL

options AbstractHttpOptionsTask-RequestOptions

Options

The options to set to customize the HTTP client

payload string

Twilio message payload

Definitions

java.nio.charset.Charset

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

connectTimeout string

Format duration

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

connectionPoolIdleTimeout string

Default PT0S

Format duration

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

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

headers object

SubType string

HTTP headers

HTTP headers to include in the request

maxContentLength integerstring

Default 10485760

The maximum content length of the response.

readIdleTimeout string

Default PT5M

Format duration

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

readTimeout string

Default PT10S

Format duration

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