Skip to main content
Home
Browse packagesDocsSign in

@pinta365/oura-api@1.0.3
Built and signed on GitHub Actions

latest
Pinta365/oura_api

Project to interact with v2 of the Oura Ring API

This package works with Node.js, Deno, BunIt is unknown whether this package works with Cloudflare Workers, Browsers
It is unknown whether this package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
It is unknown whether this package works with Browsers
JSR Score
100%
Published
a month ago (1.0.3)
Report package
class Webhook

Base class for the Oura Webhook Subscription API Class containing all the methods to access the Oura Webhook Subscription API with a client id and client secret.

Constructors

new
Webhook(
clientId: string,
clientSecret: string,
)

Creates a new Webhook API client.

Methods

createSubscription(
callbackUrl: string,
verificationToken: string,
eventType: EventType,
dataType: DataType,
): Promise<Subscription>

Creates a new webhook subscription. See setup documentation on the Oura Developer website for a detailed description of the creation workflow.

Deletes a webhook subscription.

Retrieves a specific webhook subscription by id.

Retrieves a list of current active webhook subscriptions.

Renews the expiration time of a webhook subscription.

updateSubscription(
id: string,
verificationToken: string,
callbackUrl?: string,
eventType?: EventType,
dataType?: DataType,
): Promise<Subscription>

Updates a webhook subscription.

Add Package

deno add jsr:@pinta365/oura-api

Import symbol

import { Webhook } from "@pinta365/oura-api";

---- OR ----

Import directly with a jsr specifier

import { Webhook } from "jsr:@pinta365/oura-api";

Add Package

npx jsr add @pinta365/oura-api

Import symbol

import { Webhook } from "@pinta365/oura-api";

Add Package

yarn dlx jsr add @pinta365/oura-api

Import symbol

import { Webhook } from "@pinta365/oura-api";

Add Package

pnpm dlx jsr add @pinta365/oura-api

Import symbol

import { Webhook } from "@pinta365/oura-api";

Add Package

bunx jsr add @pinta365/oura-api

Import symbol

import { Webhook } from "@pinta365/oura-api";