Home
Managing identities and users
Learn how to manage identities and users.
About webhooks
A webhook is a user-defined HTTP callback. A webhook can be triggered by an event in a web application and can be used to send data or notifications to a third-party Application Programming Interface (API).

About ClearID
Learn about the ClearID self-service physical access management solution.
What's new
Check out what's new in the latest update to ClearID.
Deployment preparation
Check your compatibility and deployment requirements.
ClearID plugin
Learn how to download and install the plugin.
Managing identities and users
Learn how to manage identities and users.
- Creating identities
  From time to time you might need to create an identity manually in Genetec ClearID™. For example, for an identity that is not part of the usual mass import process or synchronization of identities using LDAP, One Identity, or API solutions.
- Identity fields
  Use the following information to help you understand the identity fields that are used in Genetec ClearID™. The following table explains which fields are mandatory, which fields are used by Security Center, and which fields are available for use by provisioning rules.
- Granting additional permissions for identities and roles
  Some organizations require more access than the default permissions provided for a Genetec ClearID™ user. You can grant identities and roles additional permissions so that they can view or manage all identities in the system.
- Granting additional permissions for supervisors
  Some organizations require more access than the default permissions provided for a Genetec ClearID™ supervisor. You can grant supervisors additional permissions so that they can manage their direct reports.
- Viewing additional permissions
  You can use the Permissions page to review who (identities or roles) has extra access to view and manage identities. You can also use the Permissions page to verify if supervisors have extra access to manage their direct reports.
- Viewing identities
  You can view identities to check their access control status, general identity information, or verify if they have any supervisors specified.
- Modifying identities
  After you have added identities, you might need to modify the identity details. You can deactivate or activate an identity, or modify identity details after a change in job title, department, company, supervisors, personal information, and so on.
- Deleting identities
  An administrator can delete identities that have become obsolete or are no longer required. For example, when a person leaves the organization, or when an identity was created in error.
- Synchronizing identity pictures with Security Center
  To manage identity and cardholder pictures in one place, Account administrators can set Genetec ClearID™ as the preferred data source for all cardholder pictures in Security Center.
- About webhooks
  A webhook is a user-defined HTTP callback. A webhook can be triggered by an event in a web application and can be used to send data or notifications to a third-party Application Programming Interface (API).
- Creating webhooks
  You can create webhooks in Genetec ClearID™ to integrate with third-party solutions APIs so that you can notify interested parties when specific events occur.
- Viewing webhook logs
  To troubleshoot unreceived webhooks or other associated issues, third-party Application Programming Interface (API) owners can use the webhook logs to verify the status of every HTTP callback request sent to the third-party URL.
- Granting access to the web portal
  Before a user can access the Genetec ClearID™ web portal, you must grant them the required User or Administrator permissions for the website.
- Viewing your profile
  You can use the Profile page to view your profile and check your access or role membership in Genetec ClearID™.
- Viewing your site and area access
  You can use the Profile Access page to review your site and area access. This information can be used to help you identify if you need to request more access in your main site or other sites.
- About access request workflow
  An access request workflow is a series of activities performed by the system or authorized people during the life cycle of an access request. The activities can change the state and properties of access requests, affect other entities in the system, or wait for a condition to be met.
- Requesting access
  To request access for yourself, another identity, or a team member, you can use the Genetec ClearID™ self-service portal. Using a self-service portal with area approvers specified simplifies the approval process, and avoids interrupting a chain of people who might or might not be the correct approvers.
- Adding supervisors manually
  To help manage requests from your direct reports, you can manually add supervisors to the relevant identity profiles so that the supervisor approval workflow can be used.
- Viewing direct reports
  As a Supervisor, you can check the access control status, general identity information of your direct reports. You can also use the direct report list for security reviews or auditing purposes.
- Managing direct reports
  Supervisors can manage their direct reports access. This can include general identity information, area access, modifying or removing roles, task delegation, and access control.
- Transferring direct reports
  From time to time a supervisor, account administrator, or an identity might need to transfer direct reports. For example, transferring direct reports to a new hire or for a change in supervisor.
- About direct reports report
  In Genetec ClearID™, a direct reports report is a list of identities of employees that report to a supervisor. The report includes information about direct reports, delegated direct reports, job titles, companies, and access control status.
- Resetting user passwords
  If you’re unable to authenticate while signing in to an account managed by Genetec ClearID™, you can reset your password.
- About email notifications
  To inform users about specific events in the Genetec ClearID™ system, email notifications are sent.
- About delegation
  In Genetec ClearID™, delegation is the process of transferring Genetec ClearID™ tasks for site owners, area owners, area approvers, role owners, role managers, supervisors, and visit event approvers to someone else in your organization. For example, during a planned vacation, sabbatical, and so on.
- Delegating tasks to another user
  Site owners, area owners, area approvers, role owners, role managers, supervisors, and visit event approvers can temporarily transfer their Genetec ClearID™ task responsibilities to someone else in their organization by delegating their tasks to another user. For example, during a planned vacation, sabbatical, and so on.
- About user activity report
  In Genetec ClearID™, a user activity report is an audit trail of all activities related to users. The report includes timestamp information, activity type, who activity was performed by, and a details section including reason information.
- Viewing a user activity report
  You can consult the User activity report to review all user-related activities. Use the report for auditing purposes, download a copy to attach to an audit request to review offline, or manipulate or consolidate data in a spreadsheet for other audiences.
- User levels
  The following information can be used to help you understand which actions the users or roles in Genetec ClearID™ can perform.
- About identity request workflow
  An identity request workflow is a series of activities performed by the system or authorized people during the life cycle of an identity request. The activities can create an individual identity, or multiple identities using a CSV import, and add each new identity to a role to inherit relevant access for a specified period.
- Creating an identity template
  Before you can submit an identity request, you must create your identity templates.
- Requesting identities
  You can use the Genetec ClearID™ self-service portal to request an individual identity, or to request multiple identities using a CSV import. Using the self-service portal with optional approver workflow simplifies the approval process by only notifying the specified approvers.
- Canceling identity requests
  To cancel identity requests, the identity requester must review the pending requests and then decide which requests to cancel.
- Approving identity requests
  To approve identity requests, a supervisor or identity approver must review the pending approvals and then decide which requests to approve.
- About identity requests report
  In Genetec ClearID™, an identity requests report is a list of identity requests for your ClearID account. The report includes information about the identity request date, requester, name, identity template, status, and reviewers.
- Checking the status of identity requests
  As an Account administrator you can check the status of identity requests to ensure that the organization is security-compliant, audit ready, and that the requests are processed in a timely fashion.
Managing sites
Learn how to manage sites.
Managing areas
Learn how to manage areas.
Managing visitors
Learn how to manage visit requests and access requests.
Managing visitor watchlists
Learn how to manage visitor access using watchlists.
Role-based access control
Learn about role-based access control.
Connecting to other systems
Learn how to connect ClearID to other systems.
ClearID Self-Service Kiosk
Learn about the ClearID Self-Service Kiosk mobile app that simplifies visitor management and check-in.
Troubleshooting
Troubleshoot common issues that can occur.
Additional resources
Need tech support or product information? Check out these resources.
Glossary

About webhooks

2022-08-22

A webhook is a user-defined HTTP callback. A webhook can be triggered by an event in a web application and can be used to send data or notifications to a third-party Application Programming Interface (API).

Webhooks in Genetec ClearID™

In ClearID, webhooks can be created and used to notify third-party APIs when specific events occur.

Webhooks page in ClearID showing webhooks Name, URL, Event, Description, and Status.

For example, an email notification with a link to detailed information about an identity could be sent when an Identity updated event occurs, or if you require other stakeholders to be notified after an Identity requests created or Identity requests updated event occurs.

Webhook processing

After the webhook is created, the webhook service listens for a subset of specified events coming from other ClearID services. When the specified event occurs the webhook service notifies the API specified in the Webhook details section URL field.

Webhook event schemas

The schema describes the object that is sent through the webhook and the contents of the schema vary depending on the event type specified. The webhook event schema can be downloaded from the Event section of the webhook to help understand the data structure of the events so that they can be retrieved and processed correctly on the user's side of the webhook integration.

Webhooks details page in ClearID showing an Identity created event with the Download schema button highlighted.

For more information about downloading the schema, see Creating webhooks.

Webhook logs

Third-party API owners can use webhook logs to verify the status of every HTTP callback request sent to the third-party URL and to troubleshoot unreceived webhooks or other associated issues. For example, sender issues, receiver issues, and so on.

Webhook logs include the following:

Callback date: When the callback was sent (includes date range filters).
URL: The URL used to forward the webhook event notification to the relevant third-party API (program or application).
Response: The response state indicates whether the HTTP callback was successfully received by third-party API or not. For example, accepted, bad request, internal server error, and so on.

Logs section of a webhook details page in ClearID showing callback date, URL, and Response status.

Note: The webhook Logs section is only displayed at the end of the webhook details after the first callback has occurred.