API Examples

If you have a Webhook.site account, before using the API, please first create an API key here. The examples below can also be used without an account, but in that case you should remove the API key header.

cURL

Quick upload file to URL

Uploads the file example.png from the current directory.

curl -F 'file=@example.png' https://webhook.site/00000000-0000-0000-0000-000000000000

To download the file, click the Download link in the Webhook.site interface, or via the API, use the download endpoint.

Python

Fetch latest data

Requires the requests module, which can be installed using pip install requests.

Prints the 50 latest requests sent to a given URL to console.

import requests

token_id = "00000000-0000-0000-0000-000000000000"
headers = {"api-key": "00000000-0000-0000-0000-000000000000"}

r = requests.get('https://webhook.site/token/'+ token_id +'/requests?sorting=newest', headers=headers)

for request in r.json()['data']:
    print(request)

Create URL/Email address

Requires the requests module, which can be installed using pip install requests.

You'll also need to replace the API key.

import requests

json = {
  "default_status": 200,
  "default_content": "Hello world!",
  "default_content_type": "text/html",
}

headers = {
    "api-key": "00000000-0000-0000-0000-000000000000"
}

r = requests.post('https://webhook.site/token', json=json, headers=headers)

print('URL Created: https://webhook.site/' + r.json()['uuid'])

PHP

Create Token (URL/Email address)

Creates a Webhook.site Token and outputs its Web URL. You'll need to replace the API key.

<?php
$apiKey = '00000000-0000-0000-0000-000000000000';

// Create a stream context
$context = stream_context_create(['http' => [
    'method' => 'POST',
    'header' => "Api-Key: $apiKey\r\n"
]]);

// Send API request
$response = json_decode(file_get_contents('https://webhook.site/token', false, $context), true);

echo "URL Created: https://webhook.site/{$response['uuid']}";

Fetch latest data

Simple example of how to loop through the latest requests or emails sent to a Webhook.site URL or email and display in a friendly manner.

You'll need to replace the API key (if you have a Webhook.site account, otherwise leave it out) and token ID.

<?php
$apiKey = '00000000-0000-0000-0000-000000000000';
$tokenId = '00000000-0000-0000-0000-000000000000';

$url = "https://webhook.site/token/$tokenId/requests?sorting=newest";

$context = stream_context_create(['http' => ['header' => "Api-Key: $apiKey\r\n"]]);

$response = json_decode(file_get_contents($url, false, $context), true);

foreach ($response['data'] as $req) {
    echo "\n";
    echo "ID        : {$req['uuid']}\n";
    echo "Type      : {$req['type']}\n";
    echo "Date      : {$req['created_at']}\n";
    echo "User-Agent: {$req['headers']['user-agent'][0] ?? 'Unknown'}\n";
    echo "--- content begin ---\n";
    echo $req['content'];
    echo "\n--- content end ---\n";
}

Example output after running e.g. curl -X POST https://webhook.site/00000000-0000-0000-0000-000000000000 -d "Hello world":

ID        : 58980c49-7e09-4cd8-8d64-bbfcfc38a1c5
Type      : web
Date      : 2021-12-01 19:24:10
User-Agent: Paw/3.3.1 (Macintosh; OS X/11.6.0) GCDHTTPRequest
--- content begin ---
Hello world!
--- content end ---

Download all request data as files

Per default, this script saves the body content of all requests or emails sent to a URL as .json files in the /requests directory relative to the script file location.

<?php
$directory = __DIR__ . '/requests';
//$apiKey = '00000000-0000-0000-0000-000000000000';
$tokenId = '00000000-0000-0000-0000-000000000000';

if (!is_dir($directory) || !is_writable($directory)) {
    throw new Exception(sprintf('%s not writable, directory missing or rights issue.', $directory));
}

$context = stream_context_create(['http' =>
    isset($apiKey) ? ['header' => "Api-Key: $apiKey\r\n"] : [],
]);

$page = 1;

do {
    $url = sprintf('https://webhook.site/token/%s/requests?sorting=newest&page=%d', $tokenId, $page);
    $response = json_decode(file_get_contents($url, false, $context), true);

    foreach ($response['data'] as $req) {
        file_put_contents(
            sprintf('/%s/%s.json', $directory, $req['uuid']),
            $req['content']
        );
        echo(sprintf(
            "[Page %3d] Downloaded request %s sent at %s (%d bytes)\n",
            $page, $req['uuid'], $req['created_at'], $req['size']
        ));
    }

    $page++;
    sleep(1);
} while (!$response['is_last_page'] && isset($response['data']));