Webhook Events

Webhooks v2 provides a limited set of events to choose from: you could receive notifications any time a user profile was created, updated, or deleted. And that's it. If you're interested in anything else that might be taking place in your Identity Cloud – users logging on, users trying to log on but failing, API clients being created or deleted – well, for better or worse Webhooks v2 isn't going to be of much help.

That’s not the case with Webhooks v3, however: the new version of the product is not limited to a few user profile-related evmade accessible to customers. The GED is a new, multipurpose event pipeline designed for routing Identity Cloud events to the appropriate storage location. Along the way, multiple applications – ranging from Console audit logs to Webhooks v3 to Customer Insights – have the ability to retrieve event information from the stream and repackage that event information as needed. It’s the General Event Data stream that provides Webhooks v3 with so many more event types to draw from.

Important. As of this writing, only three events are included in the General Event Data Stream:
  • entityCreated
  • entityUpdated
  • entityDeleted

And before you ask, here are the answers to both of your questions:

  1. When we said that Webhooks v3 provides access to all the events that have been made accessible to customers, we simply meant that Webhooks v3 has access to all the events you’re allowed to access. As you might expect, an infrastructure as large and complex as the Identity Cloud generates a lot of events, many of them of no meaning or no interest to customers. Because of that, the Identity Cloud maintains an allow list of events that customers can access, a list that can be updated at any time by making a single API call (although currently only Akamai support personnel can make that call). For example, suppose the Identity Cloud generates event types A, B, C, D, and E; however, only events B and D are on the allow list. Which event types can you access by using Webhooks v3? You got it: events B and D. If a new event type (type F) is created and is added to the allow list then you’ll be able to access events B, D, and F.
     
  2. At this point in time there’s no simple way to determine which events are on the GED allow list. However, we'll do our best to let you know when changes are made to the allow list.