Input Partials

Manage saved parameter presets for actions and triggers.

Input Partials

Input partials are saved parameter configurations (presets) scoped to a workspace integration alias. They store default values and enforced keys that merge into action and trigger inputs at execution time.

Create Partial

POST/api/v1/partials

Create a new input partial.

Request Body

Field	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace to scope this partial to
`integrationName`	string	Yes	Integration name (e.g., `slack`, `github`)
`workspaceIntegrationId`	string (uuid)	No	Configured workspace integration instance. Recommended when an integration has multiple aliases
`integrationAlias`	string	No	Workspace integration alias. Use when `workspaceIntegrationId` is not provided
`actionName`	string	No	Action name. Omit for integration-wide or trigger-scoped partials
`triggerName`	string	No	Trigger name. Omit for integration-wide or action-scoped partials. Mutually exclusive with `actionName`
`name`	string	Yes	Display name (max 100 chars)
`description`	string	No	Description (max 500 chars)
`values`	object	Yes	Key-value pairs to pre-fill
`enforcedKeys`	string[]	No	Keys whose values cannot be overridden at runtime
`isDefault`	boolean	No	Whether this partial auto-applies when no `partialIds` are specified (default: `false`)

Response (201)

json

{
  "partial": {
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "orgId": "org_abc123",
    "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
    "integrationName": "slack",
    "workspaceIntegrationId": "8c9b3ef3-1d0b-4d5e-9e91-a5a8b0f4d111",
    "integrationAlias": "slack_bot",
    "actionName": "send_channel_message",
    "triggerName": null,
    "name": "General Channel Preset",
    "description": "Always post to #general",
    "values": { "channel": "C01ABCDEF" },
    "enforcedKeys": ["channel"],
    "isDefault": false,
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-01-15T10:00:00.000Z"
  }
}

Example

bash

curl -X POST https://api.weavz.io/api/v1/partials \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
    "integrationName": "slack",
    "integrationAlias": "slack_bot",
    "actionName": "send_channel_message",
    "name": "General Channel Preset",
    "values": { "channel": "C01ABCDEF" },
    "enforcedKeys": ["channel"]
  }'

typescript

import { WeavzClient } from '@weavz/sdk'
 
const client = new WeavzClient({ apiKey: 'wvz_your_api_key' })
 
const { partial } = await client.partials.create({
  workspaceId: '550e8400-e29b-41d4-a716-446655440000',
  integrationName: 'slack',
  integrationAlias: 'slack_bot',
  actionName: 'send_channel_message',
  name: 'General Channel Preset',
  values: { channel: 'C01ABCDEF' },
  enforcedKeys: ['channel'],
})

python

from weavz_sdk import WeavzClient
 
client = WeavzClient(api_key="wvz_your_api_key")
 
result = client.partials.create(
    workspace_id="550e8400-e29b-41d4-a716-446655440000",
    integration_name="slack",
    integration_alias="slack_bot",
    action_name="send_channel_message",
    name="General Channel Preset",
    values={"channel": "C01ABCDEF"},
    enforced_keys=["channel"],
)

typescript

const res = await fetch('https://api.weavz.io/api/v1/partials', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer wvz_your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    workspaceId: '550e8400-e29b-41d4-a716-446655440000',
    integrationName: 'slack',
    integrationAlias: 'slack_bot',
    actionName: 'send_channel_message',
    name: 'General Channel Preset',
    values: { channel: 'C01ABCDEF' },
    enforcedKeys: ['channel'],
  }),
})
 
const { partial } = await res.json()

python

import httpx
 
res = httpx.post(
    "https://api.weavz.io/api/v1/partials",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={
        "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
        "integrationName": "slack",
        "integrationAlias": "slack_bot",
        "actionName": "send_channel_message",
        "name": "General Channel Preset",
        "values": {"channel": "C01ABCDEF"},
        "enforcedKeys": ["channel"],
    },
)
 
partial = res.json()["partial"]

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	Missing required fields or invalid data
`409`	`DUPLICATE`	A partial with this name already exists in the same scope

List Partials

GET/api/v1/partials

List input partials for a workspace, optionally filtered by configured integration alias, action, or trigger.

Query Parameters

Field	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID to list partials for
`integrationName`	string	No	Filter by integration name
`workspaceIntegrationId`	string (uuid)	No	Filter by configured workspace integration instance
`integrationAlias`	string	No	Filter by workspace integration alias. Use either this or `workspaceIntegrationId`
`actionName`	string	No	Filter by action name
`triggerName`	string	No	Filter by trigger name

Response

json

{
  "partials": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "orgId": "org_abc123",
      "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
      "integrationName": "slack",
      "workspaceIntegrationId": "8c9b3ef3-1d0b-4d5e-9e91-a5a8b0f4d111",
      "integrationAlias": "slack_bot",
      "actionName": "send_channel_message",
      "triggerName": null,
      "name": "General Channel Preset",
      "description": null,
      "values": { "channel": "C01ABCDEF" },
      "enforcedKeys": ["channel"],
      "isDefault": false,
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-01-15T10:00:00.000Z"
    }
  ],
  "total": 1
}

Example

bash

curl "https://api.weavz.io/api/v1/partials?workspaceId=550e8400-e29b-41d4-a716-446655440000&integrationName=slack" \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

const { partials } = await client.partials.list({
  workspaceId: '550e8400-e29b-41d4-a716-446655440000',
  integrationName: 'slack',
})

python

result = client.partials.list(
    workspace_id="550e8400-e29b-41d4-a716-446655440000",
    integration_name="slack",
)

typescript

const res = await fetch(
  'https://api.weavz.io/api/v1/partials?workspaceId=550e8400-e29b-41d4-a716-446655440000&integrationName=slack',
  { headers: { 'Authorization': 'Bearer wvz_your_api_key' } },
)
 
const { partials } = await res.json()

python

res = httpx.get(
    "https://api.weavz.io/api/v1/partials",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    params={"workspaceId": "550e8400-e29b-41d4-a716-446655440000", "integrationName": "slack"},
)
 
partials = res.json()["partials"]

Get Partial

GET/api/v1/partials/:id

Get a single input partial by ID.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Partial ID

Example

bash

curl https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

const { partial } = await client.partials.get('a1b2c3d4-5678-90ab-cdef-1234567890ab')

python

result = client.partials.get("a1b2c3d4-5678-90ab-cdef-1234567890ab")

typescript

const res = await fetch(
  'https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab',
  { headers: { 'Authorization': 'Bearer wvz_your_api_key' } },
)
 
const { partial } = await res.json()

python

res = httpx.get(
    "https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
 
partial = res.json()["partial"]

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Partial not found

Update Partial

PATCH/api/v1/partials/:id

Update an existing input partial.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Partial ID

Request Body

Field	Type	Required	Description
`name`	string	No	New display name
`description`	string	No	New description
`values`	object	No	New values (replaces existing)
`enforcedKeys`	string[]	No	New enforced keys (replaces existing)
`isDefault`	boolean	No	Set as default partial

Example

bash

curl -X PATCH https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "values": { "channel": "C01ABCDEF", "username": "weavz-bot" },
    "enforcedKeys": ["channel", "username"]
  }'

typescript

const { partial } = await client.partials.update('a1b2c3d4-5678-90ab-cdef-1234567890ab', {
  values: { channel: 'C01ABCDEF', username: 'weavz-bot' },
  enforcedKeys: ['channel', 'username'],
})

python

result = client.partials.update(
    "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    values={"channel": "C01ABCDEF", "username": "weavz-bot"},
    enforced_keys=["channel", "username"],
)

typescript

const res = await fetch(
  'https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab',
  {
    method: 'PATCH',
    headers: {
      'Authorization': 'Bearer wvz_your_api_key',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      values: { channel: 'C01ABCDEF', username: 'weavz-bot' },
      enforcedKeys: ['channel', 'username'],
    }),
  },
)
 
const { partial } = await res.json()

python

res = httpx.patch(
    "https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={
        "values": {"channel": "C01ABCDEF", "username": "weavz-bot"},
        "enforcedKeys": ["channel", "username"],
    },
)
 
partial = res.json()["partial"]

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	No updates provided or invalid data
`404`	`NOT_FOUND`	Partial not found
`409`	`DUPLICATE`	A partial with this name already exists

Delete Partial

DELETE/api/v1/partials/:id

Delete an input partial. Any MCP server tools referencing this partial in their partialIds arrays are automatically cleaned up.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Partial ID

Response

json

{
  "deleted": true,
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}

Example

bash

curl -X DELETE https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

await client.partials.delete('a1b2c3d4-5678-90ab-cdef-1234567890ab')

python

client.partials.delete("a1b2c3d4-5678-90ab-cdef-1234567890ab")

typescript

await fetch(
  'https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab',
  {
    method: 'DELETE',
    headers: { 'Authorization': 'Bearer wvz_your_api_key' },
  },
)

python

httpx.delete(
    "https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Partial not found

Set Default

POST/api/v1/partials/:id/set-default

Set or unset a partial as the default for its scope. Default partials auto-apply when no explicit partialIds are provided during action execution or trigger enablement.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Partial ID

Request Body

Field	Type	Required	Description
`isDefault`	boolean	Yes	Whether this partial should be the default

Example

bash

curl -X POST https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab/set-default \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"isDefault": true}'

typescript

await client.partials.setDefault('a1b2c3d4-5678-90ab-cdef-1234567890ab', true)

python

client.partials.set_default("a1b2c3d4-5678-90ab-cdef-1234567890ab", True)

typescript

await fetch(
  'https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab/set-default',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer wvz_your_api_key',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ isDefault: true }),
  },
)

python

httpx.post(
    "https://api.weavz.io/api/v1/partials/a1b2c3d4-5678-90ab-cdef-1234567890ab/set-default",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={"isDefault": True},
)

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Partial not found