Skip to main content

Grid card events

Grid card events notify you when grid cards are created or when related email notifications are sent. When a grid card event is triggered, IDaaS sends an HTTP POST request to your configured webhook URL with a JSON payload containing the event details.

Payload structure

Every grid card event payload has this structure:

{
"id": "019cf7c8-2a57-769a-a8dc-7dd6adfd23d3",
"type": "grid.created",
"accountId": "fba02d5c-2f79-4cfd-91f5-6bd454e97ab3",
"eventTime": "2026-03-16T17:53:36Z",
"data": {
// Event-specific data here
}
}

The data object contains event-specific fields. See the event examples later on this page for the full data object for each event type.

Top-level fields

FieldTypeDescription
idstringUnique identifier for this webhook delivery
typestringThe event that occurred (e.g., grid.created)
accountIdstringYour account identifier
eventTimestringWhen the event occurred (ISO 8601 format)
dataobjectDetails about what happened (varies by event type)

Event types

grid.created

Triggered when a grid card is created.

Example payload:

{
"id": "019cf7c8-2a57-769a-a8dc-7dd6adfd23d3",
"type": "grid.created",
"accountId": "fba02d5c-2f79-4cfd-91f5-6bd454e97ab3",
"eventTime": "2026-03-16T17:53:36Z",
"data": {
"subject": "7a578db7-e8c8-421c-b5aa-2975f1418932",
"subjectName": "john",
"subjectType": "USER",
"resourceName": "User Portal",
"sourceIp": "104.30.161.19",
"entityType": "GRIDS",
"entityId": "722c9dce-6c0c-49db-bfad-4ba5a6d698f9",
"entityName": "2",
"entityAttributes": {
"serialNumber": 2,
"expired": false,
"state": "PENDING",
"type": "GRID_CARD",
"userId": "john",
"createDate": "2026-03-16T17:53:36Z"
}
}
}

The data object includes the following fields:

FieldDescription
subjectID of the user for whom the grid card was created
subjectNameUsername of the user for whom the grid card was created
subjectTypeAlways USER
resourceNameWhere the grid card was created (e.g., "User Portal")
sourceIpIP address from which the grid card was created
entityTypeAlways GRIDS for grid card events
entityIdID of the grid card
entityNameGrid card identifier or serial number as a string
entityAttributesDetails about the created grid card (see below)

The entityAttributes object includes these fields:

  • serialNumber - Grid card serial number
  • expired - Whether the grid card is expired
  • state - Current grid card state
  • type - Always GRID_CARD
  • userId - Username associated with the grid card
  • createDate - Date and time when the grid card was created

grid.email.sent

Triggered when a grid card email is sent.

Example payload:

{
"id": "019cf7c8-2ea1-7f18-bd6d-cae662c4ce96",
"type": "grid.email.sent",
"accountId": "fba02d5c-2f79-4cfd-91f5-6bd454e97ab3",
"eventTime": "2026-03-16T17:53:37Z",
"data": {
"subject": "7a578db7-e8c8-421c-b5aa-2975f1418932",
"subjectName": "john",
"subjectType": "USER",
"resourceName": "Administration Portal",
"sourceIp": "104.30.161.19",
"entityType": "GRIDS",
"entityId": "722c9dce-6c0c-49db-bfad-4ba5a6d698f9",
"entityName": "2",
"entityAttributes": {
"contactValue": "john.smith@example.com",
"contactType": "Email"
}
}
}

The data object includes the following fields:

FieldDescription
subjectID of the user associated with the emailed grid card
subjectNameUsername of the user associated with the emailed grid card
subjectTypeAlways USER
resourceNameWhere the email was sent from (e.g., "Administration Portal")
sourceIpIP address from which the email was sent
entityTypeAlways GRIDS for grid card events
entityIdID of the grid card
entityNameGrid card identifier or serial number as a string
entityAttributesDelivery details for the emailed grid card (see below)

The entityAttributes object includes these fields:

  • contactValue - Email address that received the grid card message
  • contactType - Contact method used for the delivery

grid.password.email.sent

Triggered when a grid card password email is sent.

Example payload:

{
"id": "019cf7c8-2ea3-75e2-8044-f74c5187c403",
"type": "grid.password.email.sent",
"accountId": "fba02d5c-2f79-4cfd-91f5-6bd454e97ab3",
"eventTime": "2026-03-16T17:53:37Z",
"data": {
"subject": "7a578db7-e8c8-421c-b5aa-2975f1418932",
"subjectName": "john",
"subjectType": "USER",
"resourceName": "Administration Portal",
"sourceIp": "104.30.161.19",
"entityType": "GRIDS",
"entityId": "722c9dce-6c0c-49db-bfad-4ba5a6d698f9",
"entityName": "2",
"entityAttributes": {
"contactValue": "john.smith@example.com",
"contactType": "Email"
}
}
}

This event uses the same data structure as grid.email.sent.

FieldDescription
subjectID of the user associated with the emailed grid card password
subjectNameUsername of the user associated with the emailed grid card password
subjectTypeAlways USER
resourceNameWhere the email was sent from (e.g., "Administration Portal")
sourceIpIP address from which the email was sent
entityTypeAlways GRIDS for grid card events
entityIdID of the grid card
entityNameGrid card identifier or serial number as a string
entityAttributesDelivery details for the emailed grid card password (see below)