Webhooks
Get project webhook configuration
Get the current webhook URL, events, version, and transformations for a project. This is **where Mudbase POSTs event payloads**; it does **not** return a `webhookId`. Delivery ids (`WebhookLog._id`) come from **`POST /api/webhooks/trigger`** or automatic deliveries, and from **list logs** endpoints. Requires ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key) with project read access.
GET
/api/webhooks/projects/{projectId}/configSDK 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',
apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.
const webhooks = new WebhooksApi(configuration);import { Configuration, WebhooksApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.
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.getWebhookConfig("proj_dLgJmu7UX5ap");const { data: result } = await webhooks.getWebhookConfig("proj_dLgJmu7UX5ap");Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Get your API key from the console
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT Requires API Key JWT or API Key
Note
This endpoint accepts either JWT Bearer token or API Key. Use
Authorization: Bearer YOUR_TOKEN for user context, or X-API-Key: YOUR_KEY for server-to-server. View authentication guide →Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Include your API key in the X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | — |
Responses
200Webhook configuration
json
{
"success": true,
"data": {
"webhookUrl": "https://your-app.com/webhooks/mudbase",
"webhookEvents": [
"collection.insert",
"collection.update"
],
"webhookVersion": "1.0",
"transformations": [],
"hasSecret": true
}
}{
"success": true,
"data": {
"webhookUrl": "https://your-app.com/webhooks/mudbase",
"webhookEvents": [
"collection.insert",
"collection.update"
],
"webhookVersion": "1.0",
"transformations": [],
"hasSecret": true
}
}404Project not found
json
{
"success": true,
"error": "program back up"
}{
"success": true,
"error": "program back up"
}500—
Errors
| Code | Meaning |
|---|---|
404 | Project not found |
500 | — |