Skip to main content
GET
/
api
/
v1
/
hooks
/
{id}
Get
package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.Hooks.Get(ctx, operations.C1APIHooksV1HooksServiceGetRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.HooksServiceGetResponse != nil {
        // handle response
    }
}
{
  "hook": {
    "builtinPattern": {
      "creditCardBlocking": {},
      "piiRedaction": {
        "redactFields": [
          "<string>"
        ],
        "replacement": "<string>"
      },
      "queryScopeLimit": {
        "fields": [
          "<string>"
        ],
        "maxLimit": 123
      },
      "sensitiveFileGuard": {
        "blockedDirectories": [
          "<string>"
        ],
        "blockedPatterns": [
          "<string>"
        ]
      },
      "writeAuthorization": {
        "blockedClassifications": [],
        "businessHours": {
          "days": [
            123
          ],
          "end": "<string>",
          "start": "<string>",
          "timezone": "<string>"
        }
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "displayName": "<string>",
    "enabled": true,
    "filter": {
      "celExpression": "<string>"
    },
    "function": {
      "commitId": "<string>",
      "functionId": "<string>"
    },
    "id": "<string>",
    "priority": 123,
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

​
id
string
required

The id field.

Response

200 - application/json

Successful response

The HooksServiceGetResponse message.

​
hook
Hook · object

Hook represents a customer-configured interception point for tool calls.

This message contains a oneof named hook_type. Only a single field of the following list may be set at a time:

  • function
  • builtinPattern