Test 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"
  }
}

POST /api/configs/inline-hooks/test

O auth2

Test an inline hook script with a sample context.

application/json

Body Required

script string Required

The inline hook script to test.
hookType string Required

The inline hook type to test.

Values are inlineHook.postFirstFactorVerification or inlineHook.postSignIn.
event object | null | array[string | number | boolean | null | object] | string | number | boolean Required

The sample event 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.
environmentVariables object

The environment variables for the inline hook script.
Hide environmentVariables attribute Show environmentVariables attribute object
- * string Additional properties

Responses

200 application/json

The result of the 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.
400

The request body or response body is invalid.
401

Unauthorized
403

Cloud connection does not have enough permission to perform the action or the tenant's subscription plan does not support this feature.
422

The inline hook script failed to execute.

POST /api/configs/inline-hooks/test

curl \
 --request POST 'https://[tenant_id].logto.app/api/configs/inline-hooks/test' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"script":"string","hookType":"inlineHook.postFirstFactorVerification","event":{},"environmentVariables":{"additionalProperty1":"string","additionalProperty2":"string"}}'

Request examples

{
  "script": "string",
  "hookType": "inlineHook.postFirstFactorVerification",
  "event": {},
  "environmentVariables": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}

Response examples (200)

{}

[
  "string"
]

string

42.0

true

Test inline hook

Body Required

event object | null | array[string | number | boolean | null | object] | string | number | boolean Required

Responses