Create

Invokes the c1.api.hooks.v1.HooksService.Create method.

POST /api/v1/hooks

Create

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"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.Create(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.HooksServiceCreateResponse != nil {
        // handle response
    }
}

200

{
  "hook": {
    "builtinPattern": {
      "creditCardBlocking": {},
      "piiRedaction": {
        "redactFields": [
          "<string>"
        ],
        "replacement": "<string>"
      },
      "queryScopeLimit": {
        "fields": [
          "<string>"
        ],
        "maxLimit": 123
      },
      "sensitiveFileGuard": {
        "blockedDirectories": [
          "<string>"
        ],
        "blockedPatterns": [
          "<string>"
        ]
      },
      "writeAuthorization": {
        "blockedClassifications": [
          "TOOL_CLASSIFICATION_UNSPECIFIED"
        ],
        "businessHours": {
          "days": [
            123
          ],
          "end": "<string>",
          "start": "<string>",
          "timezone": "<string>"
        }
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "displayName": "<string>",
    "enabled": true,
    "event": "HOOK_EVENT_TYPE_UNSPECIFIED",
    "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.

Body

application/json

The HooksServiceCreateRequest message.

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

• function
• builtinPattern

displayName · string · required

The displayName field.

builtinPattern · Built In Pattern · object

BuiltInPattern references a ConductorOne-maintained DLP pattern. The specific pattern and its configuration are encoded as a oneof.

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

• piiRedaction
• creditCardBlocking
• queryScopeLimit
• writeAuthorization
• sensitiveFileGuard

Show child attributes

description · string

The description field.

enabled · boolean

The enabled field.

event · enum<string>

The event field.

Available options: HOOK_EVENT_TYPE_UNSPECIFIED, HOOK_EVENT_TYPE_PRE_TOOL_USE, HOOK_EVENT_TYPE_POST_TOOL_USE

filter · Hook Filter · object

HookFilter determines which tool calls a hook applies to.

Show child attributes

function · Hook Function Ref · object

HookFunctionRef identifies a customer-authored function to invoke.

Show child attributes

priority · integer<int32>

The priority field.

Response

200 - application/json

Successful response

The HooksServiceCreateResponse 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

Show child attributes