Okta Event Hooks

Javascript, PHP
  • What are the Okta Event Hooks:
    • Event Hooks are Okta’s implementation of the industry concept of webhooks
    • Event Hooks are outbound calls from Okta that can be used to notify your own software systems of events occurring in your Okta org
    • They take the form of HTTPS REST calls to a URL you specify
    • encapsulating information about the events in JSON objects in the request body.
    • These calls from Okta are meant to be used as triggers for process flows within your own software systems.
    • To handle Event Hook calls from Okta
      • you need to implement a web service with an Internet-accessible endpoint.
      • Okta defines the REST API contract for the requests that it will send.
    • They are different from inline hooks.  They do not affect execution of the underlying Okta process flow.
    • Event Hooks are asynchronous calls, meaning that the process flow that triggered the Event Hook continues without stopping or waiting for any response from your external service.
    • Event Hooks provide an Okta-initiated push notification.
    • You can have a maximum of 10 active and verified Event Hooks set up in your org at any time, and each Event Hook can be configured to deliver multiple event types.
    • To deliver event information, Event Hooks uses data structure associated with the System Log API.
    • To see a list of events eligible for event hooks, click HERE
  • Useful tutorials:
  • Step by Step Guide to Set Up An Event Hook
  • Management API
  • Flow:
    • Configure an Event Hook for certain event
    • Create an external web service to handle the event.
    • Event happens, automatically triggers the event hook, sending a payload to the external web service.  The payload, which will sent via HTTPS POST will provide information about the event.  Click here for an example.