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>"
}
'

import requests

url = "https://api.lobstr.io/v1/delivery/test-{route}"

payload = {
    "email": "<string>",
    "url": "<string>",
    "bucket": "<string>",
    "aws_access_key": "<string>",
    "aws_secret_key": "<string>",
    "host": "<string>",
    "port": 123,
    "username": "<string>",
    "password": "<string>",
    "directory": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    email: '<string>',
    url: '<string>',
    bucket: '<string>',
    aws_access_key: '<string>',
    aws_secret_key: '<string>',
    host: '<string>',
    port: 123,
    username: '<string>',
    password: '<string>',
    directory: '<string>'
  })
};

fetch('https://api.lobstr.io/v1/delivery/test-{route}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/delivery/test-{route}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'url' => '<string>',
    'bucket' => '<string>',
    'aws_access_key' => '<string>',
    'aws_secret_key' => '<string>',
    'host' => '<string>',
    'port' => 123,
    'username' => '<string>',
    'password' => '<string>',
    'directory' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/delivery/test-{route}"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"url\": \"<string>\",\n  \"bucket\": \"<string>\",\n  \"aws_access_key\": \"<string>\",\n  \"aws_secret_key\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 123,\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"directory\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lobstr.io/v1/delivery/test-{route}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"email\": \"<string>\",\n  \"url\": \"<string>\",\n  \"bucket\": \"<string>\",\n  \"aws_access_key\": \"<string>\",\n  \"aws_secret_key\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 123,\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"directory\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/delivery/test-{route}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"email\": \"<string>\",\n  \"url\": \"<string>\",\n  \"bucket\": \"<string>\",\n  \"aws_access_key\": \"<string>\",\n  \"aws_secret_key\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 123,\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"directory\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

POST

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>"
}
'

import requests

url = "https://api.lobstr.io/v1/delivery/test-{route}"

payload = {
    "email": "<string>",
    "url": "<string>",
    "bucket": "<string>",
    "aws_access_key": "<string>",
    "aws_secret_key": "<string>",
    "host": "<string>",
    "port": 123,
    "username": "<string>",
    "password": "<string>",
    "directory": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    email: '<string>',
    url: '<string>',
    bucket: '<string>',
    aws_access_key: '<string>',
    aws_secret_key: '<string>',
    host: '<string>',
    port: 123,
    username: '<string>',
    password: '<string>',
    directory: '<string>'
  })
};

fetch('https://api.lobstr.io/v1/delivery/test-{route}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/delivery/test-{route}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'url' => '<string>',
    'bucket' => '<string>',
    'aws_access_key' => '<string>',
    'aws_secret_key' => '<string>',
    'host' => '<string>',
    'port' => 123,
    'username' => '<string>',
    'password' => '<string>',
    'directory' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/delivery/test-{route}"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"url\": \"<string>\",\n  \"bucket\": \"<string>\",\n  \"aws_access_key\": \"<string>\",\n  \"aws_secret_key\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 123,\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"directory\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lobstr.io/v1/delivery/test-{route}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"email\": \"<string>\",\n  \"url\": \"<string>\",\n  \"bucket\": \"<string>\",\n  \"aws_access_key\": \"<string>\",\n  \"aws_secret_key\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 123,\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"directory\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/delivery/test-{route}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"email\": \"<string>\",\n  \"url\": \"<string>\",\n  \"bucket\": \"<string>\",\n  \"aws_access_key\": \"<string>\",\n  \"aws_secret_key\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 123,\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"directory\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

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

string

required

Your API authentication token. Value: Token YOUR_API_KEY

string

required

Must be application/json. Value: application/json

Query Parameters

string

required

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

Test Email - Request Body

string

required

Email address to test. Example: "user@example.com"

Test Google Sheet - Request Body

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

string

required

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

Test Amazon S3 - Request Body

string

required

S3 bucket name to test. Example: "my-bucket"

string

(Optional) AWS Access Key for authentication. Example: "AKIAIOSFODNN7EXAMPLE"

string

(Optional) AWS Secret Key for authentication. Example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

Test SFTP - Request Body

string

required

SFTP server hostname or IP. Example: "sftp.example.com"

integer

required

SFTP server port. Example: 22

string

required

SFTP username. Example: "user"

string

required

SFTP password. Example: "password"

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"
  }'

import requests

# Test webhook endpoint
url = "https://api.lobstr.io/v1/delivery/test-webhook"
headers = {
    "Authorization": "Token YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "url": "https://your-webhook.com/endpoint"
}

response = requests.post(url, headers=headers, json=payload)
result = response.json()

print("Webhook test completed!")
print(f"Success: {result['success']}")
if 'status_code' in result:
    print(f"Status code: {result['status_code']}")

Response

200

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

Configure Webhook Delivery List Accounts

Overview

Getting Started

Core Concepts

User

Crawler

Squid

Delivery

Account

Task

Run

Result

Test Delivery Configuration

Available Test Endpoints

Headers

Query Parameters

Test Email - Request Body

Test Google Sheet - Request Body

Test Webhook - Request Body

Test Amazon S3 - Request Body

Test SFTP - Request Body

Code Examples

Response

​Available Test Endpoints

​Headers

​Query Parameters

​Test Email - Request Body

​Test Google Sheet - Request Body

​Test Webhook - Request Body

​Test Amazon S3 - Request Body

​Test SFTP - Request Body

​Code Examples

​Response

Available Test Endpoints

Headers

Query Parameters

Test Email - Request Body

Test Google Sheet - Request Body

Test Webhook - Request Body

Test Amazon S3 - Request Body

Test SFTP - Request Body

Code Examples

Response