Every time something new happens in your account, Universign creates an event. An event corresponds to a modification of a resource you interacted with, or with the usage you made of a service. For example, if you create or delete an API key, an event is triggered such as apikey.created or apikey.deleted. Please note that Universign only logs events linked to API requests that returned a 200 status code.
Access your workspace’s events
If your account has API entitlements and if you are its Owner, or have an Admin or Integrator role, you then have access to a Developer space from your workspace. To view your workspace’s events, navigate to the Events section of the Developer space.
The list of webhookable events is as follows:
Apikey events
apikey.created(the apikey has been created)apikey.updated(the apikey name has been updated)apikey.deleted(the apikey has been deleted)
Transaction events
transaction.lifecycle.created(the transaction has been created in draft)transaction.lifecycle.started(the transaction has been started)transaction.lifecycle.paused(the transaction has been paused)transaction.lifecycle.cancelled(the transaction has been cancelled)transaction.lifecycle.expired(the transaction has been expired)transaction.lifecycle.completed(all participants have performed their actions, the transaction is completed and all signed documents are ready to be retrieved)transaction.chat.message.received(the transaction creator received an instant message send by the participant)
Participant action events
action.opened(the action is ready to be performed by the participant)action.closed(the participant has performed his/her action)action.stalled(the participant hasn’t performed his/her action within the allotted time)action.manualreminder.sent(a manual reminder has been sent to the participant)action.reminder.sent(an automatic reminder has been sent to the participant)action.waitingperiod.cancelled(the waiting period has been cancelled within the transaction)action.waitingperiod.ended(the waiting period has ended and the participant can perform his action now)
Note that a participant’s action can be stalled for one of the following reasons:
action_refusal(the participant refused to authenticate on the signature page)signature_refusal(the participant refused a document to sign)consultation_refusal(the participant refused a document to read)review_refusal(the participant refused a document to review)
The stall reason is indicated in the action.stalled event payload.
Identity validation events
identity-validation.processed(The identity has been verified)
Registration events
| Event | Description |
|---|---|
registration.identity.verified |
The identity has been verified with a verification_status value among success or failure. |
registration.identity.rejected |
The validated identity has been rejected. The user decalred an error in his/data extracted and presented as valid. This rejection can be due to an extraction error or an input error in the data recording file. |
registration.lifecycle.rejected |
Identity information rejected at the beginning of the process if one of the registration requirements specified by the registration creator is not respected (i.e. user full name and/or phone number). |
registration.lifecycle.expired |
The registration session has expired. Note that a registration has a lifetime of 7 days. After this period, if it has not been used to create a certificate, it is deleted. |
registration.lifecycle.completed |
Registration is complete: the user has chosen a certificate name and signed the subscription agreement. |
registration.certificate.activated |
The certificate has been issued and is ready to be used. |
Filter your workspace’s events
An event search returns all the events that match your input filters. If no result match your search, you are indicated so.
- by period: Select the search format for the period, either Before a specific date or Between two specific dates and enter a search value,
- by type: This refers to the name of the resource or the service you interacted with,
- by API key: Select the API key that was used to authenticate the requests.
Note that you can export the list of events matching your search to CSV file.
Display information about a specific event
Click an event to view its detailed information.
Each event includes:
- an envelope that contains data about the event itself,
- the response body that was returned by the API.
Retrieve consumption report
You may need to retrieve useful information about your consumption within Universign’s transactions service. Do do so, you can get an events report to count the number of signatures, visas, seals and reviews used over a given period.
To retrieve a transaction event report, send a request to GET /v1/events/report:
curl
https://api.universign.com/v1/events/report?created_gt=2022-12-19T00:00:00Z&created_lt=2023-01-19T00:00:00Z
The API returns an events-report object.
{
"object": "events-report",
"total": 40,
"visas": 0,
"seals": 0,
"reviews": 3,
"signatures": 37,
"signatures_by_required_level": {
"level_1": 25,
"level_2": 12
}
}
