Hooks

Create a hook

Changed on

Create a new hook with the given data.

post/api/hooks

Request

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

Request body

tenantIdstring
namestring

The name of the hook.

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'

Use events instead.

eventsstring[]

An array of hook events.

enabledboolean
createdAtnumber

Response

The hook was created successfully.

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

    • info

      added the new TrustedDevice.Created enum value to the request property

    • info

      added the new TrustedDevice.Created enum value to the request property /

    • info

      added the new TrustedDevice.Deleted enum value to the request property

    • info

      added the new TrustedDevice.Deleted enum value to the request property /