neosourceDocs
Search docs

Get a webhook

GET/api/repos/{owner}/{repo}/hooks/{webhook_id}

getWebhook

Returns a single webhook by ID. Requires admin access.

Requires authentication using a bearer token or a session cookie — see tokens and scopes.

curl

curl -X GET 'https://neosource.dev/api/repos/OWNER/REPO/hooks/WEBHOOK_ID' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN'

fetch

fetch("https://neosource.dev/api/repos/OWNER/REPO/hooks/WEBHOOK_ID", {
  method: "GET",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
  },
});

Path parameters

ownerrequired

Repository owner or organization slug.

string

reporequired

Repository name.

string

webhook_idrequired

Webhook ID.

string

Responses

200Webhook details

application/json

WebhookResponse

object

activerequired

boolean

created_atrequired

integerint64

eventsrequired

array

Event types this webhook is subscribed to.

items

WebhookEventType

string

User-facing event types for webhook subscriptions. The vocabulary is deliberately closed today (`push` / `pull_request` are the only events we emit); the `OpenAPI` spec advertises it as a real enum so SDK clients get exhaustive types. New events extend this enum.

"push""pull_request""mention""assigned""review_requested""issue_comment"

repo_idrequired

string

updated_atrequired

integerint64

urlrequired

string

webhook_idrequired

string

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 401Authentication required
  • 403Forbidden — one of: forbidden
  • 404Not Found — one of: not_found
  • 423Locked — one of: busy
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget