Setting Up And Configuring An Event Hook

It is possible to create an Okta event hook either by using the management API or the admin console. We will discuss how to set up and configure a webhook using both methods below.

Configuring an Event Hook using the REST admin API

An event hook can be created by making an authenticated HTTP POST request to Okta’s /api/v1/eventHooks endpoint along with the information of the intended event hook to be created as the request body. A sample of a JSON request body for registering an event hook can be seen below

    {
      "name": "Name Of Event Hook",
      "events": {
        "type": "EVENT_TYPE",
        "items": ["user.lifecycle.create", "user.lifecycle.activate"]
      },
      "channel": {
        "type": "HTTP",
        "version": "1.0.0",
        "config": {
          "uri": "https://www.YOURSSLSECUREURLENDPOINT",
          "headers": [
            {
              "key": "X-Other-Header",
              "value": "some-other-value"
            }
          ],
          "authScheme": {
            "type": "HEADER",
            "key": "Authorization",
            "value": "${api-key}"
          }
        }
      }
    }

Within the request body, as seen above, we include all the parameters relevant to the event hook to be created in the body.

Configuring an Event Hook using the Admin Console

The alternative way to create an event hook is through Okta’s admin console UI. Once signed in, navigate to the Workflow > Event Hooks page and click Create Event Hook. Fill in the fields appropriately. The official documentation has more information about the fields you are expected to fill. It is important to note that event hooks can only be created and retrieved by super admins.

Guide on Okta Webhooks Features and Best Practices

Instantly & reliably manageyour webhooks

Instantly & reliably manage
your webhooks