GunSpec

Webhooks

Signed delivery of catalog changes to your own endpoint. An endpoint subscribes to events (firearm.updated, catalog.resynced and the rest) and receives the same payload GET /v1/firearms/{id} returns, so a mirror can apply a delivery without re-fetching. Every request carries a signature made with the secret create() returns once. Failed deliveries are retried on a schedule, so a brief outage at your end costs nothing.

Auth RequiredExplorer+

client.webhooks.test()

Send a signed test delivery, so a new endpoint can be verified before an event depends on it.

test(id: string): Promise<APIResponse<WebhookTestResult>>
POST/v1/me/webhooks/{endpointId}/test

Explorer+

  • stringheaderrequired

    Your API key. Authorization: Bearer <key> is accepted in its place.

  • stringrequired

    Webhook endpoint id

    Example

application/json

  • object

    The response payload.

  • boolean

    Whether your endpoint answered with a 2xx.

  • integer | null

    The status your endpoint returned. Null when the request never got a response: DNS failure, timeout, TLS error.

  • string | null

    Why the calculation could not be completed, or null when it succeeded.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 404NOT_FOUNDResource not found
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Full rate limits

Minimum tier
Explorer+
Monthly quota
200/mo
Rate limit
10/min
Daily cap
50

Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.