Event hooks are outbound calls from Okta that trigger process flows within software systems. They are sent when specific events occur in the org and deliver information about the event. This article explains how a feature can be set up and implemented for notification purposes.
- Webhooks
- Notification system
- Eligible events
-
Set Up a Webhook: Webhooks can be configured to receive notifications for specific events, such as application assignment errors or user lockouts.
-
In the Admin Console, go to Workflow > Event Hooks.
- Click Create Event Hook.
-
Complete these fields:
- Endpoint URL: Enter the external service's endpoint URL where the event hook sends the request.
- Event Hook name: Enter a unique name for the event hook.
- Description: Optional. Enter the purpose and a description of the event hook.
-
Optional. For enhanced security and to secure the communication channel between Okta and the external service, add authentication under Enhance security:
-
Authentication field: Enter the name of the authorization header.
- Authentication secret: Enter the value that corresponds to the field name.
-
-
Optional. To create custom proprietary headers for extra authorization security, click Add Field under Custom headers, and then complete these fields:
-
Field Name: Enter a name for the custom header.
-
Value: Enter a value for the field name.
-
-
Click inside the text box under Select Events, and then select the events that should be added.
-
Click Create hook & Continue to save the unverified event hook.
-
-
Define the Events: Specify the events to monitor in Okta. This could include user lockouts or application assignment errors. To find the events eligible for this process, visit the Okta Event Types Catalog.
-
Create an Endpoint: Set up an endpoint URL in the receiving application that will listen for incoming webhook payloads from Okta. To do so, use the Admin Console from the Workflow > Event Hooks page.
-
Receive and Process Data: Once the specified events trigger the webhook, the endpoint will receive the data/notifications.
