Webhooks
Test webhook transformation
Apply transformation rules to a sample payload and return original and transformed payloads. Requires ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key) with project update access.
POST
/api/webhooks/projects/{projectId}/test-transformationSDK 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.testWebhookTransformation(
"proj_Yr6nrOS4ViKU",
{
payload: "panel synthesize",
transformations: "system transmit"
}
);const { data: result } = await webhooks.testWebhookTransformation(
"proj_Yr6nrOS4ViKU",
{
payload: "panel synthesize",
transformations: "system transmit"
}
);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 | — |
Request Body
json
{
"payload": {},
"transformations": [
{
"type": "filter",
"config": {}
}
]
}{
"payload": {},
"transformations": [
{
"type": "filter",
"config": {}
}
]
}Responses
200Transformation result
json
{
"success": true,
"data": {
"original": {
"event": "collection.insert",
"data": {
"name": "Test"
}
},
"transformed": {
"event": "collection.insert",
"data": {
"name": "Test"
}
}
}
}{
"success": true,
"data": {
"original": {
"event": "collection.insert",
"data": {
"name": "Test"
}
},
"transformed": {
"event": "collection.insert",
"data": {
"name": "Test"
}
}
}
}400payload and transformations are required
json
{
"success": true,
"error": "program back up"
}{
"success": true,
"error": "program back up"
}404Project not found
500—
Errors
| Code | Meaning |
|---|---|
400 | payload and transformations are required |
404 | Project not found |
500 | — |