Skip to main content
PUT
Set the webhook endpoint

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Body

application/json
url
string<uri> | null

A public https URL. Required the first time; null removes the endpoint.

Example:

"https://example.com/guidinghand"

events
enum<string>[]

Only these events; an empty list for all. Unknown types are a 400.

Available options:
session.connected,
session.disconnected,
task.started,
task.waiting_for_user,
task.question_answered,
task.waiting_for_approval,
task.approval_decided,
task.completed,
task.failed,
task.stopped
rotate_secret
boolean

Response

OK

object
any
url
string | null
events
enum<string>[]
Available options:
session.connected,
session.disconnected,
task.started,
task.waiting_for_user,
task.question_answered,
task.waiting_for_approval,
task.approval_decided,
task.completed,
task.failed,
task.stopped
has_secret
boolean
secret
string

Only when it was just made.

event_types
enum<string>[]
Available options:
session.connected,
session.disconnected,
task.started,
task.waiting_for_user,
task.question_answered,
task.waiting_for_approval,
task.approval_decided,
task.completed,
task.failed,
task.stopped