Hooks

Get hook

Changed on

Get hook details by ID.

get/api/hooks/{id}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/hooks/{id}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the hook.

Query parameters

includeExecutionStatsstring

Whether to include execution stats in the response.

Response

Details of the hook.

tenantIdstring required
idstring required
namestring required
event'PostRegister' | 'PostSignIn' | 'PostSignInAdaptiveMfaTriggered' | 'PostResetPassword' | 'User.Created' | 'User.Deleted' | 'User.Data.Updated' | 'User.SuspensionStatus.Updated' | 'TrustedDevice.Created' | 'TrustedDevice.Deleted' | 'Role.Created' | 'Role.Deleted' | 'Role.Data.Updated' | 'Role.Scopes.Updated' | 'Scope.Created' | 'Scope.Deleted' | 'Scope.Data.Updated' | 'Organization.Created' | 'Organization.Deleted' | 'Organization.Data.Updated' | 'Organization.Membership.Updated' | 'OrganizationRole.Created' | 'OrganizationRole.Deleted' | 'OrganizationRole.Data.Updated' | 'OrganizationRole.Scopes.Updated' | 'OrganizationScope.Created' | 'OrganizationScope.Deleted' | 'OrganizationScope.Data.Updated' | 'Identifier.Lockout' | 'Message.RateLimited' | 'Grant.LimitExceeded' nullable required
eventsstring[] required
signingKeystring required
enabledboolean required
createdAtnumber required

Changes

  • 5768a9ce87dbRevision changes
    • warning

      added the new TrustedDevice.Created enum value to the response property for the response status

    • warning

      added the new TrustedDevice.Created enum value to the / response property for the response status

    • warning

      added the new TrustedDevice.Deleted enum value to the response property for the response status

    • warning

      added the new TrustedDevice.Deleted enum value to the / response property for the response status