SendToWebhook Method

Overview

The sendToWebhook method uploads files to a webhook endpoint that was created during task initialization. This method is only available if the pipeline configuration includes a webhook component.

Method Signature

Parameters

Returns

• Type: Promise<object>
• Description: API response confirming file upload

Throws

• Error: If no webhook is configured, no files match the pattern, or upload fails

Prerequisites

Usage Examples

Basic File Upload

const AparaviDTC = require('aparavi-dtc-node-sdk');

const client = new AparaviDTC('your-api-key');

async function uploadFilesToWebhook() {
  try {
    // Start a task with webhook component
    const pipeline = {
      pipeline: {
        components: [
          {
            name: 'source',
            provider: 'file',
            config: { path: '/data/source' }
          },
          {
            name: 'destination',
            provider: 'webhook',
            config: { url: 'https://your-webhook.com/upload' }
          }
        ]
      }
    };
    
    await client.startTask(pipeline);
    console.log('Task started with webhook');
    
    // Upload all CSV files in the data directory
    const result = await client.sendToWebhook('./data/*.csv');
    console.log('Files uploaded successfully:', result);
    
  } catch (error) {
    console.error('Error uploading files:', error.message);
  }
}

uploadFilesToWebhook();

Response Format

Successful File Upload

{
  data: {
    files_uploaded: 5,
    total_size: 1024000,
    upload_time: '2024-01-15T10:30:00Z',
    webhook_url: 'https://your-webhook.com/upload',
    status: 'completed'
  },
  message: 'Files uploaded successfully'
}

Failed File Upload

{
  error: 'No files found matching pattern',
  message: 'No files found matching glob pattern: ./nonexistent/*.txt'
}

Error Handling

Common File Upload Errors

No Webhook Configured

No Files Found

Upload Failed

File Upload Patterns

Single File Upload

// Upload a specific file
await client.sendToWebhook('./data/export.csv');

Multiple File Types

// Upload files that end in the extensions csv, json, or xml
await client.sendToWebhook('./data/*.{csv,json,xml}');

Recursive Directory Upload

// Upload all files in directory and subdirectories
await client.sendToWebhook('./data/**/*');

Pattern-Based Upload

// Upload files with specific naming pattern
await client.sendToWebhook('./data/export_*.csv');

Performance Considerations

• File Size: Large files may timeout – consider chunking
• Network Speed: Upload speed depends on network connection
• Batch Size: Multiple files are uploaded in a single request
• Memory Usage: Files are loaded into memory during upload

Security Notes

• File Validation: Validate file types before upload
• HTTPS Only: Webhook URLs should use HTTPS
• Access Control: Ensure webhook endpoint is secure
• File Permissions: Check file accessibility before upload

Related Methods

• startTask() – Start a task with webhook component
• getTask() – Check webhook task status
• deleteTask() – Clean up webhook tasks

API Endpoint

Next Steps