Test Webhook Delivery

POST

/webhooks/{id}/test

• Production

Fire a synthetic delivery to the registered URL with { "test": true } payload. Useful when validating endpoint signature handling. Records the result in failure_count / last_status_code.

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/webhooks/{id}/test \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json"

Node.js

const res = await fetch('https://api.astroway.info/v1/webhooks/{id}/test', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

Python

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/webhooks/{id}/test',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

PHP

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('webhooks/{id}/test', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Responses

200

Successful calculation

object

ok

boolean

Example

true

data

object

id

number

delivered

boolean

status_code

number

duration_ms

number

Example

{
  "ok": true,
  "data": {
    "id": 42,
    "delivered": true,
    "status_code": 200,
    "duration_ms": 124
  }
}

400

Validation error

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}