Skip to main content

Webhooks

Hovi’s webhook endpoints allow tenants to configure webhooks to get notified whenever key events occur within your ecosystem. You can create, retrieve, and remove a webhook using Hovi’s webhook endpoints.

Hovi triggers webhooks for the following operations:

  1. Connection completion (Privado.ID, Indicio, Cheqd): Notifies when a connection has been successfully established.
  2. Credential acceptance (All ecosystems): Notifies when a user has accepted a credential.
  3. Proof verification (All ecosystems): Notifies when a proof verification process has been completed.

Endpoints​

The available webhook endpoints include:

  • Add Webhook: Allows a tenant to add a webhook URL.
  • Get All Webhooks​: Retrieves a list of all webhook or find a specific webhook by webhookId for a tenant.
  • Remove Webhooks: Allows a tenant to delete a webhook URL that is no longer needed.

Example: Configuring Webhooks in OpenID​

Follow these steps to configure a webhook in the OpenID ecosystem.

  1. Visit the Hovi API Reference.
  2. Select the OpenID Ecosystem API under the Business Wallet API dropdown.
  3. Navigate to Webhooks section.
  4. To create a webhook navigate to POST - Add Webhook endpoint and click “Test Request”.
  5. Enter the API key as a Bearer Token, provide the body parameters, and click “Send”.

A new webhook URL will be associated with your tenant.

Contents