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 AdminAn abbreviation of administrator. This is the individual(s) who have access to the Okta Administrator Dashboard. They control the provisioning and deprovisioning of end users, the assigning of apps, the resetting of passwords, and the overall end user experience. Only administrators have the Administration button on the upper right side of the My Applications page. Console, go to Workflow > Inline Hooks.
  2. Click Add Inline Hook, and then select the type of hook.
  3. Define the following attributes:
  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 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.