Product DocumentationVersion 9.1+ Documentation
HYPR User GuidePostman APILegacy WFALegacy SDK

Event Hook: Custom

HYPR Control Center Standard: Integrations

Adding custom event hooks allows HYPR-enabled sites to gather and interpret HYPR Events using their own custom installation, rather than using HYPR's. By adding an HTTP Event Collector and using its API key to enable HYPR CC's connection, you are able to tailor the output to best suit your needs.

HYPR Events are grouped using the eventTags parameter (AUTHENTICATION, REGISTRATION, ACCESS TOKEN, etc.).

What You'll Need

  • An administrator account for your SIEM
  • An administrator account for Control Center
  • If it is not already enabled, contact HYPR Support to enable Custom Event Hooks for the RP application that you wish to monitor

Setting Up the SIEM

Your SIEM must be configured to communicate with Control Center. Check with your SIEM vendor to obtain the necessary credentials and parameters for the .JSON content.

Connecting Custom Event Hooks to HYPR

You will need the Custom Event Hook JSON content to proceed.

  1. Login to HYPR Control Center as an administrator.
  2. In the left navigation menu, click Integrations.
  3. On the Integrations page, click Add New Integration. CC displays available integrations.
  4. Click the tile under Event Hooks for Custom Events.
  1. Click Add New Event Hook.
  1. On the Add New Event Hook dialog, paste the desired .JSON content into the text field. See Sample JSON below.
  1. Click Add Event Hook when you are satisfied. CC returns to the Event Hooks page.

Sample JSON

{
  "name":"TestCustomEvents",
  "eventType": "ALL",
  "invocationEndpoint": "https://someurl.com",
  "httpMethod": "POST",
  "authType": "BASIC",
  "authParams": {
    "basicAuthParameters": {
      "username": "[email protected]",
      "password":"M@dH0p$24-7"
    },
    "invocationHttpParameters": {
      "headerParameters": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "isValueSecret": false
        },
        {
          "key": "Content-Encoding",
          "value": "gzip",
          "isValueSecret": false
        }
      ]
    }
  }
}

Event Hook Entries

The Event Hooks table displays values for the available Custom Event Hooks. Where applicable, these values are based upon the values used in the .JSON file contents shown above.

FieldJSON ParameterDescription
NamenameThe unique name of the Event Hook. This will appear in the RP Applications list in Control Center Standard Mode.
Event TypeeventTypeThe eventTags value associated with the Event Hook.
ADMIN | ALL | AUTHENTICATION | DEREGISTRATION | MAGIC_LINK | OFFLINE_ACCESS | REGISTRATION | SMART_KEY | WEB_REGISTRATION
EndpointinvocationEndpointThe location of the desired endpoint on the SIEM server.
Auth TypeauthTypeAPI_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS
HTTP MethodhttpMethodDELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT
Connection StateN/AAUTHORIZED | AUTHORIZING | CREATING | DEAUTHORIZED | DEAUTHORIZING | DELETING | UPDATING
Destination StateN/AACTIVE | INACTIVE
Actions
(Hover on Options)		N/AEdit | Delete
See Editing HYPR Custom Event Hooks and Deleting HYPR Custom Event Hooks for how to perform these actions.

Clicking the name of the Event Hook will open a pane with additional information about the entry. As with the above parameters, these reflect the JSON parameter values, where applicable.

FieldJSON ParameterDescription
Invocation EndpointinvocationEndpointThe location of the desired endpoint on the SIEM server. This is the same value shown under the Endpoint column on the Event Hook's main entry.
Auth ParamsauthParamsA data object encompassing basicAuthParameters and invocationHttpParameters.
N/AbasicAuthParametersA data object encompassing user authentication values.
N/AusernameThe username to authenticate to the SIEM.
N/ApasswordThe password for the username.
N/AinvocationHttpParametersA data object containing HTTP header definitions. See HTTP Headers for a full list of possible headers and acceptable values.
N/AheaderParametersA collection of header parameters for communication with the SIEM. Each header is defined by the following properties: key, value, and isValueSecret.
N/AkeyThe name of the header parameter being used.
N/AvalueThe value of the header parameter being used.
N/AisValueSecretDoes this value need to be occluded in the SIEM?
true | false
Connection State ReasonN/AThe reason that the connection is in the connection state.

Clicking Back to Custom Events returns you to the Event Hooks page.

See Event Descriptions: Event Parameters for a full rundown on all Event parameters and their values.

Editing HYPR Custom Event Hooks

  1. On the Custom Events Integration Event Hooks table, on the right side under Actions, click Options-> Edit for the Event Hook you wish to modify.
  1. The Event Hook Details dialog opens. Make changes as needed using the values given in Connecting Custom Event Hooks to HYPR, Step 6, above.
  1. Click Save to return to the Event Hooks page.

Deleting HYPR Custom Event Hooks

  1. In the Event Hooks table, on the right side under Actions, click Options-> Delete for the Event Hook you wish to remove.
  2. The Delete Event Hook dialog opens. Click Delete to remove the event hook.
  1. A dialog appears confirming the Event Hook was deleted. CC returns to the Event Hooks page.

πŸ‘

Housekeeping

You may also wish to delete the related data from your SIEM if it is not used by any other systems.

Updated 5 months ago