Account

Get a webhook endpoint

Returns one of your webhook endpoints.

Requires an API key belonging to a user account. Acts on the calling account's own data.

get/v1/me/webhooks/{endpointId}

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/me/webhooks/{endpointId}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

endpointIdstring required

Webhook endpoint id

Response

Get a webhook endpoint

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "url": "https://example.com/hooks/gunspec",
    "events": [
      "firearm.created"
    ],
    "active": true,
    "createdAt": "2026-08-23T02:00:00.000Z",
    "updatedAt": "2026-08-23T02:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.