After implementing your external service, you need to register it with Okta. To do this, you need to make a REST API call to the Event Hooks Management API. You can use a tool like Postman to make the call, and Okta provides a Postman collection to make this easier.

You make a POST call to https://${yourOktaDomain}/api/v1/eventHooks to register your endpoint. The body of the request needs to contain a JSON payload containing an eventHook object, which specifies the properties of the Event Hook you are registering, including:

  • the URI of your external service's endpoint
  • the list of specific event types this Event Hook should deliver
  • the secret value Okta should send in the authorization header of requests, to authenticate to your service

See Event Hook Object for a description of the object.

If the operation is successful, Okta sends back a 200 OK response also containing an eventHook object in its body, confirming the properties of the created Event Hook. The object also includes a system-generated id property, which is the unique identifier for the newly-created Event Hook. You need to provide this id property later when using the Event Hooks Management API to perform additional operations on this Event Hook.


Featured Guides