n8n Nodes for Yournotify

This folder stores the starter package for the future public n8n-nodes-yournotify repo. It should stay in developer/channels/n8n while we build and validate it, then be copied or pushed into its own GitHub repository when it is ready for n8n community distribution.

Package: n8n-nodes-yournotify

Current State

• API-key credential scaffold: src/credentials/YournotifyApi.credentials.ts
• Action node scaffold: src/nodes/Yournotify/Yournotify.node.ts
• Delivery webhook trigger scaffold: src/nodes/YournotifyDeliveryTrigger/YournotifyDeliveryTrigger.node.ts
• Example workflows: examples/lead-capture-workflow.json, examples/delivery-monitoring-workflow.json
• Local consistency check: npm run check
• Local package artifact: npm pack produces n8n-nodes-yournotify-0.1.0.tgz

Goal

Publish a community n8n node package that lets developers and operators use Yournotify inside automations without custom HTTP node setup.

Authentication

• Credential type: Yournotify API Key
• Header: Authorization: Bearer {{$credentials.apiKey}}
• Base URL default: https://api.yournotify.com

Nodes

Initial action node: Yournotify

Resources and operations:

• Auth
  • Validate API key (GET /auth/me)
• Contacts
  • Create contact
  • Update contact
  • Get contact
  • List contacts
  • Delete contact
• Lists
  • Create list
  • List lists
  • Get list
• Campaigns
  • Create email campaign
  • Create SMS campaign
  • Create WhatsApp campaign
  • Create push campaign
  • Send test campaign
  • List campaigns
  • Get campaign stats
  • Get campaign reports
• Rewards
  • Create reward
  • Send reward
  • List reward products
  • List reward submissions
• Webhooks
  • Delivery updated trigger for email/SMS/WhatsApp

Implementation Notes

• Build on top of the Node SDK once upgraded.
• Keep provider/vendor fields out of exposed event output. Delivery triggers should emit the Yournotify developer webhook envelope with nested data.
• Use app/web/src/lib/apiDocsCatalog.ts as the public field/object-key source for action payloads.
• Use n8n trigger nodes for developer webhooks, not provider callbacks.
• Include example workflows for lead capture, abandoned checkout SMS, reward fulfillment, and WhatsApp delivery monitoring.

Readiness Checklist

• package.json with n8n.nodes and n8n.credentials entries. Done.
• Credential class. Done.
• One node class with resource/operation routing. Started.
• Webhook trigger node. Started.
• Unit tests or at least mocked request tests.
• README with screenshots and workflow JSON examples.

Build Notes

npm install
npm run check
npm run build
npm pack

npm run check does not require network or installed dependencies. npm run build requires the package dependencies from package.json.

The local machine currently runs Node 26, while n8n packages target active LTS runtimes. This package declares node >=20 <25; npm may warn on Node 26, but the package still builds locally because runtime n8n types are kept as an optional peer dependency.