2 mins read

Setting up Event-based Notifications

Set up event-based notifications in order to subscribe third-party applications to important events captured by the Cloudentity platform, such as Open Banking consents or data access requests. As a developer, you can also consume the Webhook CRUD APIs.

About Event-based Notifications in Cloudentity

Event-based Notifications allow you to build secure event communication between Cloudentity and third parties. For example, such communication could grant the ability to track and present information about the approved transactions or data access requests within an external client portal or provide an audit of transactions in an external CRM system. It is up to you to decide which events captured by Cloudentity are communicated via notifications. They could be, for example:

  • User consent grants and revocations in the Open Banking space
  • Registration of a new client application
  • Tokens being issued and revoked
  • New services being discovered by the authorizers

Event-based notifications are implemented via Webhooks (user-defined one-way HTTP callbacks triggered by events) added to a Cloudentity workspace. Each webhook is responsible for a single target URL. Cloudentity sends a notification together with a Webhook-specific API key to the target URL each time an event you set up to trigger the webhook occurs. HTTPS communication between Cloudentity and the target is enforced by default, but can be turned off by the administrator.

flowchart TB app(Third-party application) acp(Cloudentity) wh(Trigger Webhook) stop(End) decision{Event subscribed?} acp-- Event captured -->decision decision-- Yes -->wh decision-- No -->stop wh-- Send notification to provided URL -->app style stop fill:#e32a20 style app fill:#28c912

Note that not all events are captured by all workspaces. For example, if you subscribe to Open Banking events, and your workspace is not an Open Banking workspace, you won’t get notifications since the data source (audit events) won’t be available. For more information on audit events, read Getting Business Audit Data Using Cloudentity’s Audit Events.

Create a Webhook for Event-based Notifications

  1. Go to Extensions > Webhooks.

  2. Select Create Webhook. Fill in the necessary data:

    Field Description
    URL Address to send the notification to
    Subscribed events Select events which trigger the notification from the list. Keep in mind that events are specific to the workspace type.
  3. Select Create to confirm. Copy the API key when notified - this API key is always sent with the outbound Cloudentity request so that you can use it to protect the target server.

    Your webhook is created. Event-based notifications should now be triggered in this workspace. If you want to disable certificate validation when sending requests from Cloudentity, activate the Developer mode.

Updated: Apr 14, 2023