Documentation

n8n      AvantGuard

SaaSAlerts - Raw Event Webhooks n8n Node

n8n community node npm

OverviewThese APIs allows partners to subscribe to original unprocessed event data.For example, the API enables partners to: - Create new subscription - Retrieve all active subscriptions for current partner - Retrieve list of disabled subscriptions for current partner - Update subscription - Delete subscription - Retrieve list of unsent queues of events for current partner - Retrieve list of unsent queues of events for current channel - Retrieve list of events for current channel - Delete channel from queue - Send Test - Retrieve list of endpoints by Product Type# Getting Started To get started with the SaaS Alerts API, follow these steps: 1. Obtain an API key by navigating to Settings > API in the SaaS Alerts dashboard, and clicking on the “Show key” button under Manage API. 2. Use the API key to authenticate requests to the API and start using our endpoints. The documentation provides the details on the available endpoints, request/response structures, and authentication mechanism # Support If you have any questions or need further assistance, please don’t hesitate to contact our support team. We are always here to help!

Table of Contents

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-saasalertsraweventwebhooks

Authentication

This node authenticates using an API Key.

Setting Value
Type API Key
Sent in header
Header / Query name api_key
Base URL https://us-central1-the-byway-248217.cloudfunctions.net/outgoingWebhookRawApi/api/v1 (editable in credentials)

Tip: The Base URL can be changed in the credential settings if your instance uses a different host.

Resources & Operations

Base URL: https://us-central1-the-byway-248217.cloudfunctions.net/outgoingWebhookRawApi/api/v1

OriginalEventSubscriptions

Endpoint Description
🔵 GET /raw/subscriptions Subscriptions - list of subscriptions
🟢 POST /raw/subscriptions Subscription - create subscription
🔵 GET /raw/subscriptions/disabled Subscriptions - list of disabled subscriptions
🟣 PATCH /raw/subscriptions/{channelId} Subscription - Update subscription
🔴 DELETE /raw/subscriptions/{channelId} Subscription - Delete a subscription

DebugSubscription

Endpoint Description
🟢 POST /misc/sendTestEvent Subscription - Test Event

EndpointsInfo

Endpoint Description
🔵 GET /misc/endpoints/{productType} Subscription - Endpoints List

OriginalEventsSubscriptionQueues

Endpoint Description
🔵 GET /queue Queue - list of unsent queues
🔵 GET /queue/channels/{channelId} Queue - list of unsent queues
🔵 GET /queue/{queueId}/channels/{channelId}/events Queue - list of events
🔴 DELETE /queue/{queueId}/channels/{channelId} Queue - Delete a channel

Compatibility

  • n8n version: 1.0+ (tested on 2.x)
  • Node.js version: 18+

License

MIT

Discussion