Webhooks

Test Webhook Delivery

Changed on

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.

post/webhooks/{id}/test

Request

  • Base URL: https://api.astroway.info/v1
  • URL: https://api.astroway.info/v1/webhooks/{id}/test
  • Auth: API key in header X-Api-Key

Path parameters

idinteger required

Webhook id, as returned by GET /v1/webhooks.

Query parameters

fieldsstring

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

precisioninteger

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Request body

EmptyBody required

This endpoint reads nothing from the request body. Send {} (or any object, which is ignored).

Response

Successful calculation

okboolean

Example response

{
  "ok": true
}

Changes