Pilot Status - n8n Integration

This is the official n8n node for Pilot Status — a WhatsApp transactional, marketing, and bulk messaging platform.

With this integration, you can seamlessly connect your n8n workflows to Pilot Status to send messages, manage projects, connect WhatsApp numbers, and react to incoming messages or status changes in real time.

📦 Installation

To install this node in your n8n instance, follow these steps:

For n8n UI (Community Nodes)

1. Go to Settings > Community Nodes.
2. Click on Install.
3. Enter n8n-nodes-pilot-status.
4. Click Install.

For Docker / Self-hosted

If you are hosting n8n yourself, you can install it via npm:

npm install n8n-nodes-pilot-status

Make sure to restart your n8n instance after installation.

🔑 Authentication

To use the Pilot Status node, you need an API Key.

1. Go to your Pilot Status Dashboard.
2. Create a new API Key.
3. In n8n, add a new Pilot Status API credential and paste your API Key.

Note: TEST keys will only send messages to the WhatsApp number registered in your Pilot Status Profile.

⚡ Triggers (Webhooks)

The Pilot Status Trigger node allows your workflows to react to real-time events.

To use it:

1. Add the Pilot Status Trigger node to your workflow.
2. Select the event you want to listen to (or select "All Events").
3. Copy the Webhook URL provided by the node.
4. Go to the Webhooks section in your Pilot Status Dashboard and paste the URL.

Available Events:

• Message Sent: Triggered when the message is sent to the provider.
• Message Delivered: Triggered when the message is successfully delivered to the device.
• Message Read: Triggered when the user reads the message.
• Message Failed: Triggered if the message fails to send (includes error details).
• Message Reply: Triggered when a user replies specifically to an automated message.
• Message Received: Triggered when a general inbound message is received on your connected WhatsApp number.
• Group Message: Triggered when an inbound group message is received (group subject is included when available).

Webhook payload notes:

• Customer webhook payloads do not include: projectSlug, lastMessageId. Optional correlationId (same as HTTP 202 when present) may appear on outbound status events and on message.reply / message.received when correlated to a prior send.
• message.reply always includes messageRepliedId: Pilot Status internal id of the original outbound message when correlated, or null if none was found — use quotedMessageId with message.sent’s messageId when it is null.
• message.received includes fromMe (boolean) and fromName (string, optional).
• For outbound status events (message.sent, message.delivered, message.read, message.failed): messageId is the WhatsApp provider id (may be null) and internalMessageId is the Pilot Status message id.

🛠 Actions (Operations)

The Pilot Status node provides several resources and operations to manage your account and send messages.

1. Message

• Send: Send a template message (OTP, Utility, or Marketing). Choose Phone Number or WhatsApp Group; for groups use groupId (JID ending in @g.us) instead of destinationNumber. Optional dropdown loads groups from GET /v1/groups when the WhatsApp session is connected. Variables can be provided via JSON or the UI collection (including placeholders used in button labels).
• Get Status: Retrieve the current status of a specific message using either its Pilot Status message id or WhatsApp provider id.

2. Number

• Create: Provision a new WhatsApp number instance. It returns a base64 QR Code and optional pairingCode (letter code) for WhatsApp “link a device”. By default, the number is linked to the API Key used in the request.
• Connect (QR + pairing code): Regenerate QR and pairing code for an existing instance (only when not OPEN).
• Get Status: Check the connection status of a WhatsApp instance (e.g., CONNECTING, OPEN).

3. Project

• Create: Programmatically create a new project in your workspace.
• Get Many: List all projects associated with your account.

4. API Key

• Create: Generate new API Keys. This is highly useful for SaaS platforms that want to generate a specific API Key for each of their clients dynamically.
• Get Many: List existing API Keys.

5. Analytics

• Get Dashboard: Retrieve your messaging statistics (Total Sent, Total Failed, Failure Rate, and Daily charts) based on your timezone.

💡 Use Case Examples

Here are some ideas of what you can build with this integration:

1. Abandoned Cart Recovery: Trigger a workflow from your e-commerce platform (like Shopify or WooCommerce) to send a Pilot Status message with a discount code 1 hour after cart abandonment.
2. Customer Support Routing: Use the Trigger node to listen for Message Received. If the customer asks for help, create a ticket in Jira or Zendesk automatically.
3. SaaS Onboarding: When a new client signs up on your app, automatically create a new Project, generate an API Key, and provision a WhatsApp Number for them using n8n.
4. Appointment Reminders: Connect Google Calendar to n8n and use the deliverAt field in the Send Message operation to schedule a reminder 24 hours before the event.

📚 Documentation & Support

• API Documentation: https://pilotstatuss.com/docs
• Official Website: https://pilotstatuss.com

If you have any questions or need help, feel free to reach out to our support via the dashboard!