Webhooks

Get webhook delivery statistics

Aggregates **`WebhookLog`** rows for your organization over the last **`days`** (default 7). Optional **`projectId`** filters to a project in your org. Returns **`statusStats`** (counts and average duration per delivery **status**) and **`eventStats`** (counts and success rate per **event** name). **Auth:** Organization JWT only (`authRequired`).

AuthBearer (JWT)
GroupWebhooks
Rate limitSee Rate Limits
GET/api/webhooks/stats

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { Configuration, WebhooksApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const webhooks = new WebhooksApi(configuration);
import { Configuration, WebhooksApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const webhooks = new WebhooksApi(configuration);

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const { data: result } = await webhooks.getWebhookStats();
const { data: result } = await webhooks.getWebhookStats();

Playground

live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Query Parameters

NameTypeRequiredDescription
projectIdstringNoOptional; limit stats to this project.
daysintegerNo

Responses

200Aggregated webhook log statistics
json
{
  "statusStats": [
    {
      "_id": "success",
      "count": 85,
      "avgDuration": 210.5
    },
    {
      "_id": "failed",
      "count": 10,
      "avgDuration": 450.2
    },
    {
      "_id": "pending",
      "count": 5,
      "avgDuration": null
    }
  ],
  "eventStats": [
    {
      "_id": "collection.insert",
      "count": 40,
      "successRate": 0.95
    },
    {
      "_id": "manual.test",
      "count": 12,
      "successRate": 1
    }
  ],
  "period": "7 days"
}
{
  "statusStats": [
    {
      "_id": "success",
      "count": 85,
      "avgDuration": 210.5
    },
    {
      "_id": "failed",
      "count": 10,
      "avgDuration": 450.2
    },
    {
      "_id": "pending",
      "count": 5,
      "avgDuration": null
    }
  ],
  "eventStats": [
    {
      "_id": "collection.insert",
      "count": 40,
      "successRate": 0.95
    },
    {
      "_id": "manual.test",
      "count": 12,
      "successRate": 1
    }
  ],
  "period": "7 days"
}
400
404Project not found or not in your org
500

Errors

CodeMeaning
400
404Project not found or not in your org
500
Edit this page on GitHub