About event hooks
Event hooks now include filtering support and a new creation flow. These are Beta features. See Beta Programs.
Okta event hooks are outbound requests sent from Okta to a URL endpoint when events occur within your org. Events such as account changes can activate an event hook request. The event hook request contains event information enclosed inside of a JSON object and it is sent to an endpoint. The endpoint uses the event information and returns the appropriate notification to the org.
When using event hooks admins should:
-
View and configure event hooks with super admin credentials.
-
Implement a web service with an Internet-accessible endpoint.
-
Host your code on a system that is external to Okta.
-
Consider Workflows as your web service without hosting code on your system.
See Event Hook Management API.
Topics
Event hook events
Events are based on a defined behavior. Okta provides a catalog of events that you can choose from when configuring their event hook. Examples of events are, group events, application events, user sign-in events and user profile events.
Event hooks page
Use the event hooks page to view and manage existing event hooks and to create new event hooks.
See About the Event Hooks page
Event hook endpoints
An event hook endpoint is an internet-accessible endpoint that processes event hook requests from Okta. You need to register the endpoint of the external service with Okta and then configure event hook parameters. A one-time verification process ensures that the endpoint is controlled by the admin who is configuring the event hook.
See One-Time Verification Request.
Event hook preview
Event hook preview lets you review how a new event hook interacts with custom code before it is enabled. The event hook preview includes the JSON payload of an event hook request. The JSON payload only contains event data and not user profile objects. You can use this information to troubleshoot how your code responds to an event. If you discover issues, you can edit the JSON payload before it's delivered to the endpoint.
When events are not generated for an event type, the event hook preview displays an example event with sample data. These sample event hook preview requests are generated using real values from recent events. Preview requests for events that have not been generated contain sample values. Undetermined fields are set to null and you can replace them with custom values for testing.
Event hook filters
Event hook filters let you filter events so that you receive only the events that you are interested in viewing. Some event hooks can result in a significant number of events. Filters let you focus on events that meet a given condition. For example, events matching specific values such as email.
Create filters with the Okta Expression Language
If an event supports the Okta Expression Language, you can use it to create filters.
See About the Okta Expression Language .