Managing Actions

After importing Actions into your App, you can update their configuration, fetch details, and organize them effectively.

Prerequisites

Before managing Actions, ensure you have:

The Ductape SDK installed and initialized
An App with imported Actions

import Ductape from '@ductape/sdk';

const ductape = new Ductape({
  workspace_id: 'your-workspace-id',
  user_id: 'your-user-id',
  private_key: 'your-private-key',
});

// Set the app context
await ductape.app.init({ app: 'my-app' });

Fetching Actions

Fetch All Actions

Retrieve all Actions within the current App:

const actions = await ductape.actions.fetchAll();

actions.forEach((action) => {
  console.log(`${action.name} (${action.tag})`);
  console.log(`  Method: ${action.method}`);
  console.log(`  Endpoint: ${action.resource}`);
  console.log(`  Description: ${action.description}`);
});

Fetch a Specific Action

Get details about a single Action by its tag:

const action = await ductape.actions.fetch('send-email');

console.log('Action Details:');
console.log('  Name:', action.name);
console.log('  Tag:', action.tag);
console.log('  Method:', action.method);
console.log('  Resource:', action.resource);
console.log('  Description:', action.description);

Updating Actions

Update an Action's configuration using the update function. You can modify the description, resource path, name, or HTTP method.

const updatedAction = await ductape.actions.update('send-email', {
  description: 'Send transactional emails via SendGrid API',
  resource: '/v3/mail/send',
  method: 'POST',
});

console.log('Updated:', updatedAction.tag);

Updatable Fields

Field	Type	Description
`name`	string	Human-readable display name
`description`	string	Explanation of what the Action does
`resource`	string	API endpoint path
`method`	string	HTTP method (GET, POST, PUT, DELETE, etc.)

Update Examples

Update Description Only

await ductape.actions.update('create-customer', {
  description: 'Creates a new customer in the payment system',
});

Update Endpoint Path

await ductape.actions.update('list-products', {
  resource: '/api/v2/products',
});

Update HTTP Method

await ductape.actions.update('update-user', {
  method: 'PATCH', // Changed from PUT to PATCH
});

Multiple Updates

await ductape.actions.update('webhook-handler', {
  name: 'Stripe Webhook Handler',
  description: 'Processes incoming Stripe webhook events',
  resource: '/webhooks/stripe',
  method: 'POST',
});

Best Practices

Use Descriptive Names

Give Actions clear, action-oriented names:

// Good
await ductape.actions.update('send-email', {
  name: 'Send Transactional Email',
});

// Avoid
await ductape.actions.update('send-email', {
  name: 'Email', // Too vague
});

Document Your Actions

Always add meaningful descriptions:

await ductape.actions.update('charge-customer', {
  description: 'Charges the customer for a one-time payment. Requires a valid payment method attached to the customer.',
});

Keep Resources Up to Date

When APIs change versions, update your resource paths:

// Migrate to v2 API
await ductape.actions.update('list-users', {
  resource: '/api/v2/users',
});

Next Steps

Data Validation - Set up validation rules for Action inputs
Running Actions - Execute Actions with different input patterns
Actions Overview - Return to the Actions overview

Prerequisites​

Fetching Actions​

Fetch All Actions​

Fetch a Specific Action​

Updating Actions​

Updatable Fields​

Update Examples​

Update Description Only​

Update Endpoint Path​

Update HTTP Method​

Multiple Updates​

Best Practices​

Use Descriptive Names​

Document Your Actions​

Keep Resources Up to Date​

Next Steps​

See Also​