Inline Hooks

Inline hooks are outbound calls from Okta to your own custom code, triggered at specific points in Okta process flows. They allow you to integrate custom functionality into those flows.

You implement your custom code as a web service with an Internet-accessible endpoint. It's your responsibility to arrange hosting of your code on a system external to Okta. Okta defines the REST API contract for the requests it sends to your custom code, as well as for the responses your custom code can send back.

The outbound call from Okta is called a hook. Your code, which receives the call, is referred to as your external service.

Inline hooks use synchronous calls, which means that the Okta process that triggered the hook is paused until a response from your service is received.

Learn more about Inline Hooks.

Add an Inline Hook

Note: Only Super Admins can view and configure Inline Hooks.

After creating your external service, you need to tell Okta that it exists and enable it for a particular process flow.

  1. In the Admin Console, go to Workflow > Inline Hooks.
  2. Click Add Inline Hook, and then select the type of hook.
  3. Define the following attributes:
    • Name: a descriptive name for the inline hook
    • URL: the external service's endpoint URL, to which the inline hook sends the request
    • Authentication field: the name of the authorization header
    • Authentication secret: the value string that corresponds to the field name
    • Custom header fields: optional field name / value pairs to send with the request
  4. Click Save.The inline hook is now Active.
  5. Associate the endpoint with an Okta process flow. How to do this varies by Inline Hook type.

Delete an Inline Hook

  1. In the Admin Console, go to Workflow > Inline Hooks.
  2. Locate the Inline Hook that you want to delete, and then click its Actions menu. Note: By default, active Inline Hooks are listed first, but you can sort the table by type or name.
  3. Select Deactivate.
  4. Click the hook's Actions menu again, and then select Delete.

View usage metrics for your Inline Hooks

Monthly metrics show you successful and unsuccessful executions of your enabled inline hooks. You can use these numbers to assess the performance of your hooks and troubleshoot unexpected behavior.

  1. In the Admin Console, go to Workflow > Inline Hooks.
  2. Locate the inline hook that you want to view metrics for, and then click its Actions menu. Note: By default, active inline hooks are listed first, but you can sort the table by type or name.
  3. Select Metrics.
  4. Click the Metrics tab to view the following:
    • Successful executions: the number of times that the hook executed successfully in the last 30 days
    • Unsuccessful executions: the number of times that the hook did not execute successfully in the last 30 days
    • Average execution time: the average amount of time to successfully execute in the last 30 days