Account

Update a webhook endpoint

Updates the URL, subscribed events, description, or active state of one of your endpoints.

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

put/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

Request body

urlstring

Where deliveries are POSTed. A public https hostname on port 443: no IP address, no credentials in the URL, and not a gunspec.io or workers.dev host. Redirects are not followed, so register the final URL. At most 2,048 characters.

eventsstring[]

Event types this endpoint is subscribed to. The full list is on the POST operation.

descriptionstring

Prose summary of the record, where one has been written.

activeboolean

False while the endpoint is paused. A paused endpoint receives nothing and is not retried.

Example request

{
  "url": "https://example.com/hooks/gunspec",
  "description": "Production ingest",
  "active": true
}

Response

Update 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.