Actions
Send Document Message

Send WhatsApp document messages from your WhatsApp Business Account.

Params

keyrequired
string

A unique string. Please see the Keys and Resumability doc for more info.

messagerequired
object
fromId
string

The id of the phone number you want to send the message from. You can find this in the your WhatsApp Business dashboard. Note, this is not the phone number.

to
string

The phone number you want to send the message to.

urlrequired
string

The url of the document to be sent.

caption
string

Optional caption that sits below the video

isReplyTo
string

Optionally, add the id of the message you want to reply to. It will appear as a reply in the WhatsApp chat.

Response

contacts
object

The contact information of who received the message

messages
object

An array of message ids that were sent

messaging_product
string

Always whatsapp

Example Workflows

Notify Slack on New GitHub Star

import { Trigger } from "@trigger.dev/sdk";
import { events, sendDocument } from "@trigger.dev/whatsapp";

new Trigger({
  id: "demo",
  on: events.messageEvent({
    accountId: "<account_id>",
  }),
  run: async (event, ctx) => {
    //send an automatic document reply to the message
    const documentResponse = await sendDocument("doc", {
      fromId: event.metadata.phone_number_id,
      to: event.message.from,
      url: "https://upload.wikimedia.org/wikipedia/commons/2/20/Re_example.pdf",
      caption: "A pdf for you",
    });
  },
}).listen();