Webhook Events
Clients can subscribe to the Webhooks of the Lissi Agent to get informed about a variety of events. As an alternative to the HTTP-based Webhook events, clients can also subscribe to Kafka or WebSocket events.
Subscribing to Webhook Events
Clients can subscribe to Webhook events via the HTTP API.
Subscribe |
|
Unsubscribe |
|
Each Webhook subscription only serves the events of one tenant. Clients can subscribe to the Webhook events of multiple tenants in order to receive events of multiple tenants. In order to know to which tenant an event belongs it is recommended to encode the tenant ID in the client's base URL (e.g. https://sample-client.com/events/<tenant-id>
).
Webhook Endpoints
The following table lists the Webhook events that are sent by the Lissi Agent to the clients.
Endpoint | Payload | Description |
|
CODE
| Informs about an state update of a connection. The possible states are:
(see also https://github.com/hyperledger/aries-rfcs/tree/main/features/0160-connection-protocol) |
| n/a | Informs about the deletion of ONE connection. The URL paths encodes the ID of the connection that has been deleted. |
|
CODE
| Informs about the deletion of connections. The payload is a list of IDs of all the connections that have been deleted. |
|
CODE
| Informs about an state update of a connection. The possible states are:
(see also https://github.com/hyperledger/aries-rfcs/tree/main/features/0036-issue-credential ) |
| n/a | Informs about the deletion of ONE credential. The URL paths encodes the ID of the credential that has been deleted. |
|
CODE
| Informs about the deletion of credentials. The payload is a list of IDs of all the connections that have been deleted. |
| n/a | Informs about the revocation of ONE credential. The URL paths encodes the ID of the credential that has been revoked. Every deleted credential will also be revoked in case the credential definition used to create this credential is revocable. |
|
CODE
| Informs about the revocation of credentials. The payload is a list of IDs of all the connections that have been revoced. Every deleted credential will also be revoked in case the credential definition used to create this credential is revocable. |
|
CODE
| Informs about an state update of a proof request. The possible states are:
(see also https://github.com/hyperledger/aries-rfcs/tree/main/features/0037-present-proof) |
| n/a | Informs about the deletion of ONE proof request. The URL paths encodes the ID of the proof request that has been deleted. |
|
CODE
| Informs about the deletion of proof requests. The payload is a list of IDs of all the proof reuests that have been deleted. |
Authentication
To authenticate the Webhook calls, the Lissi Agent includes the header X-API-Key
in all the requests sent to the clients. The API key is defined when subscribing to the Webhook events.
Failure Handling
In case a client is not available when an event is sent out the event will be lost. Currently, there is no retry mechanism in place. The Lissi Agent will log an error in case it failed to send any Webhook event to a subscribed client.