Webhooks

Create Webhook Subscription

Changed on

Subscribe to outbound webhook deliveries. Events: report-ready, transit-alert, eclipse-alert. Returns a signing_secret used to verify the X-AstroWay-Signature HMAC-SHA256 header on each delivery.

post/webhooks/subscribe

Request

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

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

event'report-ready' | 'transit-alert' | 'eclipse-alert' | 'transit-trigger' | 'retrograde-start' | 'retrograde-end' | 'return-due' | 'dasha-change' | 'mahadasha-end' | 'void-of-course-start' | 'planetary-hour-tick' | 'sign-ingress' required
urlstring uri required

Response

Successful calculation

okboolean

Example response

{
  "ok": true
}

Changes

  • b64222844186Revision changes
    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter precision