How to add a connector endpoint
Open Webhooks in the dashboard
Configure connection settings
Define table schema and transformation (data warehouses)
Customize transformation (message connectors)
Select event types
Available connectors
Novu supports the following webhook connectors:| Connector | Type | Description |
|---|---|---|
| ClickHouse | Data warehouse | Store events in a ClickHouse table. |
| Snowflake | Data warehouse | Store events in a Snowflake table. |
| Amazon Redshift | Data warehouse | Store events in an Amazon Redshift table. |
| Amazon SQS | Message | Send events to an Amazon SQS queue. |
| Amazon SNS | Message | Send events to an Amazon SNS topic. |
Transformations
Every connector endpoint runs a JavaScript transformation before delivery. The transformation converts the raw Novu webhook into the format your destination expects. In the Novu dashboard, configure the transformation when creating or editing a connector endpoint. Each connector type ships with a default template—use it as your starting point.How to write a transformation
Svix expects a function namedhandler. For connector endpoints, the handler receives a webhook object with:
| Property | Description |
|---|---|
webhook.eventType | The Novu event type (for example, message.sent). |
webhook.payload | The webhook JSON body. Shape depends on the event type—see event types. |
webhook.method | HTTP method. Usually "POST". |
webhook.url | Destination URL. Generally leave unchanged for connectors. |
webhook.cancel | Set to true to skip delivery for a given event. Defaults to false. |
webhook object after modifying webhook.payload (and optionally other allowed properties). Test your code in the dashboard against a sample payload before going live.
switch (webhook.eventType) or equivalent logic so each event maps to a valid destination record.Data warehouse connectors
Data warehouse connectors (ClickHouse, Snowflake, Redshift, and similar) insert one row per delivered webhook. Credentials and table location alone are not enough—you must also configure:- Table schema — Column names and types that match your destination table.
- Transformation — JavaScript that maps each webhook
eventTypeandpayloadinto a row compatible with that schema.
Recommended setup flow
Grant insert permissions
Add the connector endpoint
Write the transformation
Example transformation
This example maps amessage.sent event into a flat row. Adjust field names to match your table schema and add cases for every event type you subscribe to.
Message connectors
Message connectors (Amazon SQS and Amazon SNS) publish each webhook as a queue message or topic notification. Use the transformation to shape the JSON body your consumers receive. The default template typically forwards the webhook payload. Customize it if downstream workers expect a specific structure (for example, flattening nested fields or adding metadata).ClickHouse
The ClickHouse connector stores Novu webhook events directly in a ClickHouse table. Use it when you want to analyze notification events in ClickHouse without building a custom ingestion pipeline.Configuration
| Field | Required | Description |
|---|---|---|
| URL | Yes | The ClickHouse server URL (for example, https://clickhouse.example.com:8443). |
| Username | Yes | The username used to authenticate with ClickHouse. |
| Password | Yes | The password for the ClickHouse user. |
| Table name | Yes | The name of the table where events are stored. |
| Database | No | The ClickHouse database name. If omitted, the default database is used. |
| Table schema | Yes | Column definitions that match your ClickHouse table. |
| Transformation | Yes | JavaScript that maps webhook payloads to rows matching the table schema. |
Setup
Grant insert permissions
Fill in connection settings
Snowflake
The Snowflake connector stores Novu webhook events directly in a Snowflake table. Use it when you want notification data available in your Snowflake data warehouse for reporting, analytics, or downstream pipelines.Configuration
| Field | Required | Description |
|---|---|---|
| Account identifier | Yes | Your Snowflake account identifier. |
| User ID | Yes | The Snowflake user used to authenticate. |
| Private key | Yes | The private key for key-pair authentication. |
| Database name | No | The Snowflake database where events are stored. |
| Schema name | No | The schema containing the target table. |
| Table name | No | The table where events are stored. |
| Table schema | Yes | Column definitions that match your Snowflake table. |
| Transformation | Yes | JavaScript that maps webhook payloads to rows matching the table schema. |
Setup
Configure key-pair authentication
Fill in connection settings
Amazon Redshift
The Amazon Redshift connector stores Novu webhook events directly in a Redshift table. Use it when you want notification events available in your Redshift data warehouse for analytics and reporting.Configuration
| Field | Required | Description |
|---|---|---|
| Region | Yes | The AWS region where your Redshift cluster or workgroup is located. |
| Access key ID | Yes | The AWS access key ID with permission to write to Redshift. |
| Secret access key | Yes | The AWS secret access key for the IAM user. |
| Cluster identifier | No | The Redshift cluster identifier. Required for provisioned clusters. |
| Workgroup name | No | The Redshift Serverless workgroup name. Required for serverless deployments. |
| Database user | No | The database user for provisioned clusters. |
| Database name | No | The Redshift database where events are stored. |
| Schema name | No | The schema containing the target table. |
| Table name | No | The table where events are stored. |
| Table schema | Yes | Column definitions that match your Redshift table. |
| Transformation | Yes | JavaScript that maps webhook payloads to rows matching the table schema. |
Setup
Fill in connection settings
Amazon SQS
The Amazon SQS connector sends Novu webhook events to an Amazon SQS queue. Use it when you want to process notification events asynchronously through your existing AWS messaging infrastructure.Configuration
| Field | Required | Description |
|---|---|---|
| Queue URL | Yes | The URL of the target SQS queue. |
| Region | Yes | The AWS region where the queue is located. |
| Access key ID | Yes | The AWS access key ID with permission to send messages to the queue. |
| Secret access key | Yes | The AWS secret access key for the IAM user. |
| Endpoint URL | No | A custom endpoint URL. Use this when connecting to LocalStack or other SQS-compatible services. |
| Transformation | Yes | JavaScript that shapes the message body sent to the queue. |
Setup
Fill in connection settings
Amazon SNS
The Amazon SNS connector publishes Novu webhook events to an Amazon SNS topic. Use it when you want to fan out notification events to multiple subscribers through SNS.Configuration
| Field | Required | Description |
|---|---|---|
| Topic ARN | Yes | The ARN of the target SNS topic. |
| Region | Yes | The AWS region where the topic is located. |
| Access key ID | Yes | The AWS access key ID with permission to publish to the topic. |
| Secret access key | Yes | The AWS secret access key for the IAM user. |
| Endpoint URL | No | A custom endpoint URL. Use this when connecting to LocalStack or other SNS-compatible services. |
| Transformation | Yes | JavaScript that shapes the notification body published to the topic. |
Setup
Fill in connection settings
Monitoring and troubleshooting
Connector endpoints support the same delivery monitoring, retry, and recovery features as standard webhook endpoints. From the endpoint details page in the Novu dashboard, you can:- View delivery attempts and failure reasons in the Logs tab.
- Inspect the transformed payload sent to your destination.
- Resend individual failed events.
- Recover or replay failed messages from a selected time window.
| Symptom | What to check |
|---|---|
| Authentication errors | Connector credentials, IAM permissions, or database user grants. |
| Schema or type errors | Table schema matches your destination table; transformation output uses the correct column names and types. |
| Missing rows or messages | Delivery shows success in Logs but destination is empty—transformation may not match the expected insert or message format. |
| Unhandled event types | Transformation includes a branch for every subscribed event type. |
