Event Hooks

Event hooks are outbound calls from Okta that trigger process flows within your own software systems. They are sent when specific events occur in your org, and they deliver information about the event. Unlike Inline Hooks, event hooks are asynchronous and do not offer a way to execute the Okta process flow. After sending the call, the Okta process flow continues without waiting for a response from the called service.

To set up an event hook, you need to implement 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.

Learn more about which events are eligible.

Add an event hook

Note: Only Super Admins can view and configure event 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 > Event Hooks.
  2. Click Add Event Hook.
  3. Define the following attributes:

    • Name: a descriptive name for the event hook
    • URL: the external service's endpoint URL, to which the event 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
    • Subscribe to events: the specific event types you want to use the event hook to deliver
  4. Click Save & Continue. The event hook is now Active.

 

Verify your endpoint

After saving your event hook, you need to verify your endpoint. To understand how endpoint verification works, refer to One-Time Verification Request and Verifying an Event Hook.

  1. In the Verify Endpoint Ownership window, click Verify.
  2. If Okta successfully verifies the endpoint, it is listed as Active on the Event Hooks page.

or

  1. In the Verify Endpoint Ownership window, click Do this later.
  2. When you are ready to verify the endpoint, navigate to Workflow > Event Hooks.
  3. Locate the hook that you want to verify, and then click its Actions menu. Note: By default, verified event hooks are listed first, but you can sort the table by status or name.
  4. In the Actions drop-down menu, select Verify.