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
  • event Deprecated

    Use events instead.

Responses

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":{},"retries":42.0}}'
Request example
{
  "events": [
    "PostRegister"
  ],
  "config": {
    "url": "string",
    "headers": {},
    "retries": 42.0
  }
}