Introduction

Welcome to Noviqe’s documentation. Here you’ll find guides and reference for using our API, SDKs, and webhooks.

Authentication

All requests require a bearer token. Create one in the dashboard.

curl -H "Authorization: Bearer $NOVIQE_KEY" https://api.noviqe.com/v1/memberships

Memberships

Create, fetch, and manage member subscriptions.

POST /v1/memberships
{
  "user": "12345",
  "plan": "starter",
  "provider": "discord"
}

Roles

Grant and revoke community roles based on active membership.

POST /v1/roles/sync
{
  "provider": "discord",
  "user": "12345",
  "role": "pro-member"
}

Webhooks

Subscribe to lifecycle events like membership.updated or invoice.failed.

POST /webhooks/noviqe
{
  "type": "membership.updated",
  "data": {
    "user": "12345",
    "plan": "pro",
    "active": true
  }
}

SDKs

Install our typed SDKs for a smoother developer experience.

npm install @noviqe/sdk

import Noviqe from "@noviqe/sdk";
const nov = new Noviqe({ apiKey: process.env.NOVIQE_KEY });
await nov.memberships.create({ user: "12345", plan: "pro", provider: "discord" });