Webhook setup metadata for manual GitHub configuration

GET

/integrations/webhooks/setup-info

const url = 'https://example.com/api/integrations/webhooks/setup-info';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/integrations/webhooks/setup-info \
  --header 'Authorization: Bearer <token>'

Returns payload URL, required events, and whether the server secret is configured. Does not return the secret; use POST /integrations/webhooks/reveal-secret.

Authorizations

bearerApiKey
cookieAuth

Responses

200

Setup metadata

application/json

object

webhook_url

required

string

content_type

required

string

events_mode

required

string

required_events

required

Array<string>

secret_configured

required

boolean

checklist

required

Array<string>

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean