@messagebird/n8n-nodes-bird
v0.9.2
Published
The official Bird node for n8n: email, SMS, WhatsApp, and verification, plus a webhook trigger for Bird events.
Readme
@messagebird/n8n-nodes-bird
The official Bird node, verified by n8n. Send email, SMS, and WhatsApp messages, manage contacts, run verification steps, and look up delivery status in your workflows.
📚 Bird API documentation: https://bird.com/docs
Installation
Install from the nodes panel on n8n Cloud or a self-hosted instance with verified community nodes enabled.
- Create a new workflow.
- Open the nodes panel by selecting + or pressing Tab.
- Search for Bird.
- Select Install to install the node for your instance.
- The Bird node is now available in your workflows.
On a self-hosted instance that has not enabled community nodes in the panel, use Settings → Community Nodes → Install and enter @messagebird/n8n-nodes-bird. Requires n8n 2.x on Node.js 20 or later.
Operations
The Bird node covers the public Bird API: email and SMS sends, delivery status and event timelines, WhatsApp, verification, templates, sending domains, suppressions, inbound routes, webhooks, statistics, lookup, and more. Resources and operations mirror the API reference at https://bird.com/docs/api. Four areas are deliberately out: publishing and subscribing on Realtime, which needs an app key and secret this credential cannot hold (managing Realtime apps and keys is included); the attachment and media downloads, which return bytes rather than the JSON a workflow item carries; redirect-based media fetches; and authoring reusable email templates (sending an existing email template, and listing the ones a workspace has, are covered).
- Audience (9) — Add Contacts, Create, Delete, Get, List, List Contacts, Remove Contact, Remove Contacts, Update
- Contact (7) — Batch, Create, Delete, Get, List, List Preferences, Update
- Contact Property (6) — Archive, Create, Get, List, Unarchive, Update
- Doc (2) — Read, Search
- Domain (9) — Create, Delete, Get, List, List Events, Release Tracking, Share DNS Records, Update, Verify
- Email (58) — Cancel, Content, Create Inbound Route, Create Mailbox, Create Mailbox Message, Create Mailbox Receive Rule, Delete Inbound Route, Delete Mailbox, Delete Mailbox Receive Rule, Delete Thread, Delete Thread Message, Get, Get Inbound Route, Get Mailbox, Get Mailbox Statistics, Get SMTP Config, Get Thread, Get Thread Message, Get Thread Message Body, List, List Events, List Inbound Routes, List Mailbox Labels, List Mailbox Messages, List Mailbox Receive Rules, List Mailboxes, List SMTP Configs, List Templates, List Thread Message Attachments, List Thread Messages, List Threads, Recipients, Reply to Thread Message, Restore Mailbox, Resume Mailbox, Send, Send Batch, Stats By Bounce Code, Stats By Broadcast, Stats By Category, Stats By Client, Stats By Complaint Type, Stats By Location, Stats By Mailbox Provider, Stats By Mailbox Provider Region, Stats By Recipient Domain, Stats By Sending Domain, Stats By Sending IP, Stats By Tag, Stats By Template, Stats Daily, Stats Hourly, Stats Summary, Update Inbound Route, Update Mailbox, Update SMTP Config, Update Thread, Update Thread Message
- Inbound Address (5) — Create, Delete, Get, List, Update
- Inbound Message (4) — Attachments, Body, Get, List
- Lookup (2) — Email, Phone Number
- Number (8) — Create Order, Get, Get Available Number, Get Order, List, List Available Numbers, List Orders, Release
- Preference (4) — Create, Delete, Get, List
- Realtime (9) — Create App, Create App Key, Delete App, Get App, List App Keys, List Apps, List Regions, Revoke App Key, Update App
- SMS (21) — Get, List, List Events, Send, Send Batch, Stats By Carrier, Stats By Category, Stats By Country, Stats By Error Code, Stats By Originator, Stats By Status, Stats By Tag, Stats Daily, Stats Hourly, Stats Inbound By Country, Stats Inbound By Number, Stats Inbound By Operator, Stats Inbound Daily, Stats Inbound Hourly, Stats Inbound Summary, Stats Summary
- SMS Keyword Rule (5) — Create, Delete, Get, List, Update
- SMS Suppression (4) — Add, Get, List, Remove
- SMS Template (2) — Get, List
- Suppression (4) — Add, Get, List, Remove
- Verify (3) — Create Next Channel Attempt, Create Verification, Create Verification Check
- Voice (2) — Get, List
- Webhook (9) — Attempts, Create, Delete, Get, List, Replay, Rotate Secret, Test, Update
- WhatsApp (4) — Get, List, List Events, Send
- Workspace (1) — Get
Trigger
The Bird Trigger node starts a workflow when Bird delivers a subscribed event (an email delivered, a bounce, an inbound SMS, and 50 more). It registers the webhook automatically with your API key, verifies every delivery as a Standard Webhook before the workflow runs, and deduplicates redelivered events. One Bird webhook is created per workflow; workspace webhook quotas apply.
Examples
examples/ carries ready-to-import workflows, each with its setup notes on the canvas:
- Contact form → welcome email — an n8n form captures a sign-up and Bird sends the welcome email.
- Order shipped → SMS from a stored template — a webhook triggers an SMS whose copy and translations live in Bird, not the workflow.
- Bounce & complaint handler — Bird Trigger suppresses the address and notifies the team.
Import one with Workflows → New Workflow → More options (⋮) → Import from File. examples/README.md lists the operations and the API-key scopes each needs.
Credentials
Create an API key in the Bird dashboard under API keys, near the bottom of the sidebar, and paste it into the Bird API credential. The key is all the node needs — nothing else to configure. The credential's help text lists the scopes the key needs; the credential test verifies the key against your workspace.
Limitations
An email has to fit in 20 MB once assembled, counting each attachment at its larger base64-encoded size.
