Overview of Webhook Actions and Triggers in the ID Management System
A webhook is an automatic message ID123 sends to (or receives from) another system the moment something happens — no manual export or check-in required.\r\n\r\nIn the ID123 ID Management System (IDMS), webhook events can be configured to automate workflows by either performing specific actions or responding to specific triggers. This guide provides a detailed explanation of all supported action and trigger webhook events to help you configure automated processes when managing digital ID cards.
If you’re looking to implement a webhook event that isn’t listed here, please contact us to inquire about support for additional webhook types.
Webhook Event Definitions
- Action webhooks perform operations within IDMS when triggered externally (e.g., from a third-party system or platform).
- These webhook actions are useful for integrating ID123 with external systems such as student databases, HR systems, or CRM platforms.
| 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 deactivated card record in the IDMS. |
| Delete a Card Record | Permanently deletes an existing archived card record from the IDMS. |
| Print a Card Record | Sends an existing card record to the Print Queue in the IDMS for printing. |
| Send In-App Message | Sends an in-App message to a cardholder in the ID123 Digital ID Card App, as a push notification. |
| Send a Card Invitation | Sends a card invitation to an existing card record in the IDMS. |
- Trigger webhooks are initiated when an event occurs within IDMS, allowing you to notify other systems or automate follow-up actions.
- Use these trigger events to keep your external systems synchronized with real-time updates from the ID Management System.
| Trigger Event | Description |
| 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. |
| ID Card Scanner Event | A card is scanned with the ID Card Scanner app, and the result comes back as valid, invalid, or expired. |
| Card Moderation Event | A card moderation request is submitted, approved, or denied in the IDMS. |
| Card Print Event | A print job is requested, approved, denied, queued, dispatched, or cancelled in the Print Queue. |
| Card Status- Invited | A card invitation is sent to a user from the IDMS and is now part of the Card Status webhook event. |
Enhance Automation with Webhooks in ID123
Webhook integrations are a powerful feature of the ID123 ID Management System, enabling institutions to streamline ID card issuance, updates, and access control in real-time. Whether you’re automating digital ID card creation or syncing external data platforms with card activity, these webhook events provide the necessary tools to create a seamless ID management workflow.
Need a custom webhook?
We’re continuously expanding our capabilities. If your use case requires additional webhook actions or trigger events, please contact our support team to discuss integration options.