Table of Contents
Action/Trigger Webhook Event Definitions
When creating an action or trigger webhook in the ID Management System (IDMS) you will be required to set an action or trigger event to determine what event will occur in the IDMS or what event in the IDMS will trigger a response. The following list describes the currently supported webhook actions and trigger events.
Don’t see the action or trigger webhook events you are looking for? Inquire about supporting additional webhook events.
Webhook Event Definitions
| Action Event | Description |
|---|---|
| Create a Card Record | Creates a new inactive card record in the IDMS in the designated card record group. |
| Update a Card Record | Updates specified card details of an existing card record in the IDMS. |
| Archive a Card Record | Archives an existing card record in the IDMS. |
| Deactivate a Card Record | Deactivates an existing card record in the IDMS. |
| Revoke a Card Record | Removes an existing installed card from a user’s digital ID card app. |
| Activate a Card Record | Activates an existing inactive or installed card record in the IDMS. |
| Delete a Card Record | Permanently deletes an existing archived card record from the IDMS. |
| Trigger Event | |
| Card Installed | A digital ID card is installed in one of ID123’s Digital ID Card Apps by the user. |
| Card Uninstalled | A digital ID card is uninstalled by the IDMS admin or by a user from the Digital ID Card App. |
| Card Updated | A card record is updated in the IDMS or by the user through the Digital ID Card App. |
| Card Record Added | A new card record is added to the IDMS by an admin or third-party integration. |