Events

This page describes the various events that a client can subscribe to. The events have some common properties and also a set of specific properties.

The table below describes the common properties for an event.

Property	Type	Description

Property	Type	Description
Id	Guid	An unique Id for the webhook event.
EventName	String	The name of the event.
Data	Object	An object with a set of properties for each webhook event. A common property for this object is CreatedAtDateTime which specifies the date and time the event occurred in UTC and formatted according to ISO 8601.

Available events

Data object:

Property	Type	Description

Property	Type	Description
AccountId	Guid	The BrickId of the account.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "AccountCreated",
  "Data": [
    {
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

Data object:

Property	Type	Description

Property	Type	Description
ActivityLogId	Guid	The BrickId of the activity log.
TypeKey	String	The type key of the activity log. TypeKey can be Message, Task or Note.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ActivityLogCreated",
  "Data": [
    {
      "ActivityLogId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "TypeKey": "Message",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

Data object:

Property	Type	Description

Property	Type	Description
AllocationTemplateId	Guid	The BrickId of the allocation template.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "AllocationTemplateCreated",
  "Data": [
    {
      "AllocationTemplateId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

Data object:

Property	Type	Description

Property	Type	Description
InstrumentId	Guid	The BrickId of the instrument.

JSON body example:

Data object:

Property	Type	Description

Property	Type	Description
PersonId	Guid	The BrickId of the person.

JSON body example:

BFS API

Events

Available events

Related pages