POST/v1/delivery/test-{route}

Test Delivery Configuration

Verify delivery configurations before activating them

Test endpoints allow you to verify your delivery configurations work correctly before activating automatic delivery. Each delivery method has its own test endpoint.

Available Test Endpoints

Test Email
Route:
/v1/delivery/test-email
Purpose:
Verify email address can receive notifications
Test Google Sheet
Route:
/v1/delivery/test-googlesheet
Purpose:
Verify sheet permissions and accessibility
Test Webhook
Route:
/v1/delivery/test-webhook
Purpose:
Verify webhook endpoint is reachable and responding
Test Amazon S3
Route:
/v1/delivery/test-s3
Purpose:
Verify S3 bucket permissions and credentials
Test SFTP
Route:
/v1/delivery/test-sftp
Purpose:
Verify SFTP server connectivity and credentials

Headers

KeyValueRequired
AuthorizationToken YOUR_API_KEYYes
Content-Typeapplication/jsonYes

Test Email - Request Body

emailstring
Required
Email address to test
Example: user@example.com

Test Google Sheet - Request Body

urlstring
Required
Google Sheet URL to test permissions
Example: https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing

Test Webhook - Request Body

urlstring
Required
Webhook endpoint URL to test
Example: https://your-webhook.com/endpoint

Test Amazon S3 - Request Body

bucketstring
Required
S3 bucket name to test
Example: my-bucket
aws_access_keystring
Optional
(Optional) AWS Access Key for authentication
Example: AKIAIOSFODNN7EXAMPLE
aws_secret_keystring
Optional
(Optional) AWS Secret Key for authentication
Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Test SFTP - Request Body

hoststring
Required
SFTP server hostname or IP
Example: sftp.example.com
portinteger
Required
SFTP server port
Example: 22
usernamestring
Required
SFTP username
Example: user
passwordstring
Required
SFTP password
Example: password
directorystring
Required
Target directory path
Example: /upload/path

Parameters

routestring
Required
The delivery method to test: 'email', 'googlesheet', 'webhook', 's3', or 'sftp'
Example: email
Pro Tip

Pro Tip

Always test your delivery configuration before activating automatic delivery to catch permission or connectivity issues early.
Note

Note

Test endpoints do not require a squid parameter - they only verify that your credentials and endpoints work.
Warning

Warning

A successful test response (success: true) means the configuration is valid, but doesn't guarantee future deliveries will succeed if permissions change.
Pro Tip

Pro Tip

For webhook tests, check the status_code field to ensure your endpoint returns 200/201/202 as expected.
Note

Note

Test endpoints use the same validation logic as the actual delivery system, so a successful test is a reliable indicator.