Preview an inline hook

Preview a new inline hook before you enable it to see how it will interact with your custom code. You can configure the inline hook request and then troubleshoot how your code responds.

Currently, SAML, registration, telephony, and token inline hooks are available for preview.

General procedure

Preview a telephony inline hook

Preview a token inline hook

General procedure

  1. In the Admin Console, go to Workflow > Inline Hooks.
  2. Locate the inline hook that you want to preview, and then click its Actions menu. By default, active inline hooks are listed first, but you can sort the table by type or name.
  3. Select Preview.
  4. Complete these tasks on the Preview tab:
    • In the Configure section, select a user from the user profile dropdown menu.
    • In the Preview example Inline Hook request section, click Generate Request. Verify that the example JSON payload of the request is populated with the user profile objects you configured.
    • Optional. Click Edit to customize the JSON payload of the request.
    • In the View Service Response section, click View Response.

Generated hook preview data can contain placeholder values and may differ from the preview request.

Preview a telephony inline hook

After you configure the telephony hook for your service provider, you can test its operation using the Preview action.

To test your connection to the telephony service provider:

  1. In the Admin Console, go to Workflow > Inline Hooks.

  2. Identify the telephony inline hook that is currently Active.

  3. Click Actions, and then select Preview.

  4. Select a user profile for a user with a phone as a valid authenticator.

  5. Select the event that results in an SMS text message or voice call you want to test.

    For example, select one of the following event actions:

    • MFA enrollment

    • MFA verification

    • Account unlock

    • Password reset

  6. Click Generate Request to generate the HTTP request to send to your telephony provider.

  7. Optional. Click Edit to make changes to the generated request.

    For example, you might want to edit the profile to send a text message to a phone number that you use for testing purposes.

  8. Click View Response to view the response from your service provider.

Preview a token inline hook

After you configure the token inline hook, you can test its operation using the Preview action.

  1. In the Admin Console, go to Workflow > Inline Hooks.

  2. Identify the token inline hook name that is currently Active.

  3. Click Actions, and then select Preview.

  4. From the Configure Inline Hook request block, complete the following fields:

    • Select a user: A user in your org associated with your application.

    • Select an application: Your OIDC sample application name.

    • Select an authorization server: Your authorization server name.

    • Select a grant type: Your application's grant type.

      For the implicit grant type, select a response type: token, id_token, or both.

    • Select scopes: The granted scopes.

  1. Click Generate Request to generate the HTTP request to send to your external service.

  2. Optional. Click Edit to make changes to the generated request.

  3. Click View Response to view the response body sent from your external service.

Related topics

Add an inline hook

View usage metrics for your inline hooks

Delete an inline hook