Image
abstract swish line in gradient colouring from pink to blue on a dark blue background

Event stream documentation

CustomCardDataCreated, CustomCardDataChanged and CustomCardDataDeleted events

The payload for these events contains custom card data.

A CustomCardDataCreated event will be raised when:

  • a new record is added against a card with integration enabled.

A CustomCardDataChanged event will be raised when:

  • an existing record is updated against a card with integration enabled.

A CustomCardDataDeleted event will be raised when:

  • a record is deleted against a card with integration enabled.

Field definitions for this event;

Field NameData TypeAdditional information
cardIdguidThe ID of the card schema.
cardNamestringThe name of the card schema.
entityIdguidThe ID of the linked entity.
entityTypestringThe entity type defined in the card schema. For example, it could be employee, occupancy, page...
dynamicdynamicRepeatable, each field name and data type are dynamic, based on the design of the card schema.


Example of this event

{
  "cardId": "00000001-0001-0001-0001-000000000001",
  "cardName": "Card Name",
  "entityId": "00000002-0002-0002-0002-000000000002",
  "entityType": "employee",
  "*textField": "Text goes here",
  "*checkboxField": true,
  "*numberField": 1234
}

Looking for something specific?