Skip to main content
POST
/
v1
/
delivery
/
test-
{route}
Test Delivery Configuration
curl --request POST \
  --url https://api.lobstr.io/v1/delivery/test-{route} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "email": "<string>",
  "url": "<string>",
  "bucket": "<string>",
  "aws_access_key": "<string>",
  "aws_secret_key": "<string>",
  "host": "<string>",
  "port": 123,
  "username": "<string>",
  "password": "<string>",
  "directory": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

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

EndpointRoutePurpose
Test Email/v1/delivery/test-emailVerify email address can receive notifications
Test Google Sheet/v1/delivery/test-googlesheetVerify sheet permissions and accessibility
Test Webhook/v1/delivery/test-webhookVerify webhook endpoint is reachable and responding
Test Amazon S3/v1/delivery/test-s3Verify S3 bucket permissions and credentials
Test SFTP/v1/delivery/test-sftpVerify SFTP server connectivity and credentials

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Must be application/json. Value: application/json

​
Query Parameters

​
route
string
required
The delivery method to test: ‘email’, ‘googlesheet’, ‘webhook’, ‘s3’, or ‘sftp’. Example: email

​
Test Email - Request Body

​
email
string
required
Email address to test. Example: "user@example.com"

​
Test Google Sheet - Request Body

​
url
string
required
Google Sheet URL to test permissions. Example: "https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing"

​
Test Webhook - Request Body

​
url
string
required
Webhook endpoint URL to test. Example: "https://your-webhook.com/endpoint"

​
Test Amazon S3 - Request Body

​
bucket
string
required
S3 bucket name to test. Example: "my-bucket"
​
aws_access_key
string
(Optional) AWS Access Key for authentication. Example: "AKIAIOSFODNN7EXAMPLE"
​
aws_secret_key
string
(Optional) AWS Secret Key for authentication. Example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

​
Test SFTP - Request Body

​
host
string
required
SFTP server hostname or IP. Example: "sftp.example.com"
​
port
integer
required
SFTP server port. Example: 22
​
username
string
required
SFTP username. Example: "user"
​
password
string
required
SFTP password. Example: "password"
​
directory
string
required
Target directory path. Example: "/upload/path"
Always test your delivery configuration before activating automatic delivery to catch permission or connectivity issues early.
Test endpoints do not require a squid parameter - they only verify that your credentials and endpoints work.
A successful test response (success: true) means the configuration is valid, but doesn’t guarantee future deliveries will succeed if permissions change.
For webhook tests, check the status_code field to ensure your endpoint returns 200/201/202 as expected.
Test endpoints use the same validation logic as the actual delivery system, so a successful test is a reliable indicator.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/delivery/test-webhook" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-webhook.com/endpoint"
  }'

​
Response

200
{
  "success": true,
  "status_code": 200
}