Tool: get_hook
Retrieves details of a Secure Source Manager hook.
The following code sample shows how to use curl to call the get_hook MCP tool.
| Curl Request |
|---|
curl --location 'https://securesourcemanager.europe-west4.rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_hook", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Input Schema
GetHookRequest is the request for getting a hook.
GetHookRequest
| JSON representation |
|---|
{ "name": string } |
| Fields | |
|---|---|
name |
Required. Name of the hook to retrieve. The format is |
Output Schema
Metadata of a Secure Source Manager Hook.
Hook
| JSON representation |
|---|
{ "name": string, "targetUri": string, "disabled": boolean, "events": [ enum ( |
| Fields | |
|---|---|
name |
Identifier. A unique identifier for a Hook. The name should be of the format: |
targetUri |
Required. The target URI to which the payloads will be delivered. |
disabled |
Optional. Determines if the hook disabled or not. Set to true to stop sending traffic. |
events[] |
Optional. The events that trigger hook on. |
createTime |
Output only. Create timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Update timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
uid |
Output only. Unique identifier of the hook. |
pushOption |
Optional. The trigger option for push events. |
sensitiveQueryString |
Optional. The sensitive query string to be appended to the target URI. |
Timestamp
| JSON representation |
|---|
{ "seconds": string, "nanos": integer } |
| Fields | |
|---|---|
seconds |
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z). |
nanos |
Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive. |
PushOption
| JSON representation |
|---|
{ "branchFilter": string } |
| Fields | |
|---|---|
branchFilter |
Optional. Trigger hook for matching branches only. Specified as glob pattern. If empty or , events for all branches are reported. Examples: main, {main,release}. See https://pkg.go.dev/github.com/gobwas/glob documentation. |
HookEventType
| Enums | |
|---|---|
UNSPECIFIED |
Unspecified. |
PUSH |
Push events are triggered when pushing to the repository. |
PULL_REQUEST |
Pull request events are triggered when a pull request is opened, closed, reopened, or edited. |
Tool Annotations
Destructive Hint: ❌ | Idempotent Hint: ❌ | Read Only Hint: ✅ | Open World Hint: ❌