Test Delivery Configuration
Verify delivery configurations before activating them
https://api.lobstr.io/v1/delivery/test-webhookTest endpoints allow you to verify your delivery configurations work correctly before activating automatic delivery. Each delivery method has its own distinct endpoint — there is no shared endpoint with a channel query parameter.
Available Test Endpoints
| Endpoint | Route | Purpose |
|---|---|---|
| Test Email | /v1/delivery/test-email | Verify email address can receive notifications |
| Test Google Sheet | /v1/delivery/test-googlesheet | Verify sheet permissions and accessibility |
| Test Webhook | /v1/delivery/test-webhook | Verify webhook endpoint is reachable and responding |
| Test Amazon S3 | /v1/delivery/test-s3 | Verify S3 bucket permissions and credentials |
| Test SFTP | /v1/delivery/test-sftp | Verify SFTP server connectivity and credentials |
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Content-TypestringheaderrequiredMust be application/json. Value: application/json
Test Email - Request Body
emailstringrequiredEmail address to test. Example: "user@example.com"
Test Google Sheet - Request Body
urlstringrequiredGoogle Sheet URL to test permissions. Example: "https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing"
Test Webhook - Request Body
urlstringrequiredWebhook endpoint URL to test. Example: "https://your-webhook.com/endpoint"
Test Amazon S3 - Request Body
bucketstringrequiredS3 bucket name to test. Example: "my-bucket"
aws_access_keystring(Optional) AWS Access Key for authentication. Example: "AKIAIOSFODNN7EXAMPLE"
aws_secret_keystring(Optional) AWS Secret Key for authentication. Example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
Test SFTP - Request Body
hoststringrequiredSFTP server hostname or IP. Example: "sftp.example.com"
portintegerrequiredSFTP server port. Example: 22
usernamestringrequiredSFTP username. Example: "user"
passwordstringrequiredSFTP password. Example: "password"
directorystringrequiredTarget 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
{ "success": true, "status_code": 200 }