Integrations
Execute integration
Execute an integration action (API call) with specified endpoint and parameters. Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). Both ProjectBearerAuth and ApiKeyAuth are fully implemented.
POST
/api/integrations/projects/{projectId}/integrations/{integrationId}/executeSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, IntegrationsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const integrations = new IntegrationsApi(configuration);import { Configuration, IntegrationsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const integrations = new IntegrationsApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await integrations.executeIntegration(
"proj_l9EPEoptR55Z",
"BecS5Sist8bVKka0",
{
endpoint: "matrix generate",
method: "bandwidth compress",
params: "bandwidth input",
body: "protocol bypass"
}
);const { data: result } = await integrations.executeIntegration(
"proj_l9EPEoptR55Z",
"BecS5Sist8bVKka0",
{
endpoint: "matrix generate",
method: "bandwidth compress",
params: "bandwidth input",
body: "protocol bypass"
}
);Playground
liveTest 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 →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | — |
integrationId | string | Yes | — |
Request Body
json
{
"endpoint": "interface parse",
"method": "PUT",
"params": {},
"body": {}
}{
"endpoint": "interface parse",
"method": "PUT",
"params": {},
"body": {}
}Responses
200Integration executed
json
{
"success": true,
"data": {
"status": 200,
"response": {}
}
}{
"success": true,
"data": {
"status": 200,
"response": {}
}
}400—
401—
Errors
| Code | Meaning |
|---|---|
400 | — |
401 | — |