Logto API references

Test hook

POST /api/hooks/{id}/test

Test the specified hook with the given events and config.

Path parameters

id string Required

The unique identifier of the hook.

application/json

Body Required

events array[string] Required

An array of hook events for testing.

Values are PostRegister, PostSignIn, or PostResetPassword.
config object Required

The hook configuration for testing.
Hide config attributes Show config attributes
- url string Required
- headers object
  Hide headers attributes Show headers attributes
  
  Additional properties
  
  key string
- retries number Deprecated
  
  Now the retry times is fixed to 3. Keep for backward compatibility.
event Deprecated

Use events instead.

Responses

• 204

The hook test was successful.
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found
• 422

Unprocessable Content

POST /api/hooks/{id}/test

curl \
 -X POST https://[tenant_id].logto.app/api/hooks/{id}/test \
 -H "Content-Type: application/json" \
 -d '{"events":["PostRegister"],"config":{"url":"string","headers":{"key":"string"},"retries":42.0}}'

Request example

{
  "events": [
    "PostRegister"
  ],
  "config": {
    "url": "string",
    "headers": {
      "key": "string"
    },
    "retries": 42.0
  }
}