v1

latestOpenAPI 3.0.12026-08-0435481.5 MB

Hooks

Get hook

Get hook details by ID.

get/api/hooks/{id}

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' | '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