Update inline hook

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://openapi.logto.io/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Logto API references MCP server": {
    "url": "https://openapi.logto.io/mcp"
  }
}

PATCH /api/configs/inline-hooks/{hookType}

O auth2

Update the inline hook configuration for the given hook type.

Path parameters

hookType string Required

The inline hook type to update.

Values are inlineHook.postFirstFactorVerification or inlineHook.postSignIn.

application/json

Body Required

script string

The inline hook script.
environmentVariables object

The environment variables for the inline hook script.
Hide environmentVariables attribute Show environmentVariables attribute object
- * string Additional properties
contextSample object | null | array[string | number | boolean | null | object] | string | number | boolean

The sample context for inline hook script testing.

One of:
object-1 object | null array-2 array[string | number | boolean | null | object] | null string-3 string | null number-4 number | null boolean-5 boolean | null

arbitrary JSON object

Additional properties are allowed.

One of:
string-1 string number-2 number boolean-3 boolean string-4 string | null object-5 object

null value

arbitrary JSON object

Additional properties are allowed.
enabled boolean

Whether the inline hook is enabled.
onExecutionError string

The inline hook execution error handling policy.

Values are block or allow.

Responses

200 application/json

The updated inline hook configuration.
Hide response attributes Show response attributes object
- script string Required
- environmentVariables object
  
  Hide environmentVariables attribute Show environmentVariables attribute object
  
  * string Additional properties
- contextSample object | null | array[string | number | boolean | null | object] | string | number | boolean
  
  One of:
  object-1 object | null array-2 array[string | number | boolean | null | object] | null string-3 string | null number-4 number | null boolean-5 boolean | null
  
  arbitrary JSON object
  
  Additional properties are allowed.
  
  One of:
  string-1 string number-2 number boolean-3 boolean string-4 string | null object-5 object
  
  null value
  
  arbitrary JSON object
  
  Additional properties are allowed.
- enabled boolean
- onExecutionError string
  
  Values are block or allow.
400

The request body is invalid.
401

Unauthorized
403

The tenant's subscription plan does not support this feature.
404

The inline hook configuration does not exist.

PATCH /api/configs/inline-hooks/{hookType}

curl \
 --request PATCH 'https://[tenant_id].logto.app/api/configs/inline-hooks/{hookType}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"script":"string","environmentVariables":{"additionalProperty1":"string","additionalProperty2":"string"},"contextSample":{},"enabled":true,"onExecutionError":"block"}'

Request examples

{
  "script": "string",
  "environmentVariables": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "contextSample": {},
  "enabled": true,
  "onExecutionError": "block"
}

Response examples (200)

{
  "script": "string",
  "environmentVariables": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "contextSample": {},
  "enabled": true,
  "onExecutionError": "block"
}

Update inline hook

Path parameters

Body Required

contextSample object | null | array[string | number | boolean | null | object] | string | number | boolean

Responses

contextSample object | null | array[string | number | boolean | null | object] | string | number | boolean