Logto API references

Get hooks

GET /api/hooks

Get a list of hooks with optional pagination.

Query parameters

includeExecutionStats string

Whether to include execution stats in the response.
page integer

Page number (starts from 1).

Minimum value is 1. Default value is 1.
page_size integer

Entries per page.

Minimum value is 1. Default value is 20.

Responses

• 200 application/json

A list of hooks.
Hide response attributes Show response attributes object
- id string Required
  
  Minimum length is 1, maximum length is 21.
- name string Required
  
  Maximum length is 256.
- event string | null Required
  
  Values are PostRegister, PostSignIn, or PostResetPassword.
- events array[string] Required
  
  Values are PostRegister, PostSignIn, or PostResetPassword.
- config object Required
  
  Hide config attributes Show config attributes
  
  url string Required
  
  headers object
  
  Hide headers attributes Show headers attributes
  
  Additional properties
  
  key string
  
  retries number
- signingKey string Required
  
  Maximum length is 64.
- enabled boolean Required
- createdAt number Required
- executionStats object
  
  Hide executionStats attributes Show executionStats attributes
  
  successCount number Required
  
  requestCount number Required
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden

GET /api/hooks

curl \
 -X GET https://[tenant_id].logto.app/api/hooks

Response examples (200)

[
  {
    "id": "string",
    "name": "string",
    "event": "PostRegister",
    "events": [
      "PostRegister"
    ],
    "config": {
      "url": "string",
      "headers": {
        "key": "string"
      },
      "retries": 42.0
    },
    "signingKey": "string",
    "enabled": true,
    "createdAt": 42.0,
    "executionStats": {
      "successCount": 42.0,
      "requestCount": 42.0
    }
  }
]