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
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

AccountCreated

Data object:

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"
    }
  ]
}

ActivityLogCreated

Data object:

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"
    }
  ]
}

AllocationTemplateCreated

Data object:

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"
    }
  ]
}

InstrumentCreated

Data object:

Property	Type	Description
InstrumentId	Guid	The BrickId of the instrument.

JSON body example:

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

PersonCreated

Data object:

Property	Type	Description
PersonId	Guid	The BrickId of the person.

JSON body example:

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

PowerOfAttorneyCreated

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AgentId	Guid	The BrickId of the agent.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "PowerOfAttorneyCreated",
  "Data": [
    {
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

RecurringOrderTemplateCreated

Data object:

Property	Type	Description
OrderId	Guid	The BrickId of the recurring order template.

JSON body example:

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

SubscriptionOrderCreated

Data object:

Property	Type	Description
SubscriptionOrderId	Guid	The BrickId of the order.

JSON body example:

{
  "Id": "00ee242b-382c-43c7-bb34-5b85e370898d",
  "BatchId": "fb560497-39f5-402d-896f-1959a2fdf783",
  "EventName": "SubscriptionOrderCreated",
  "Data": [
    {
      "SubscriptionOrderId": "9f8bb8fe-4d32-46e9-9c21-dd6784cf1a6b",
      "CreatedAtDateTime": "2021-03-31T09:12:24.0941805Z"
    }
  ]
}

TradeOrderCreated

Data object:

Property	Type	Description
OrderId	Guid	The BrickId of the order.

JSON body example:

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

TransactionCreated

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AssetId	Guid	The BrickId of the asset.
BusinessTransactionId	Guid	The BrickId of the business transaction.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "TradeOrderCreated",
  "Data": [
    {
      "BusinessTransactionId": "21c5d670-8887-49aa-beed-a529086b1955",
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AssetId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

TransferOrderCreated

Data object:

Property	Type	Description
OrderId	Guid	The BrickId of the order.

JSON body example:

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

TransferReceiverCreated

Data object:

Property	Type	Description
PersonId	Guid	The BrickId of the person.

JSON body example:

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

ReservationCreated

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AssetId	Guid	The BrickId of the asset.
ReservationId	Guid	The BrickId of the reservation.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ReservationCreated",
  "Data": [
    {
      "ReservationId": "f8051803-d9ee-454c-8e80-89ef6dd8bc88",
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

AccountUpdated

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.

JSON body example:

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

ActivityLogUpdated

Data object:

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

JSON body example:

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

AllocationTemplateUpdated

Data object:

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

JSON body example:

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

InstrumentUpdated

Data object:

Property	Type	Description
InstrumentId	Guid	The BrickId of the instrument.

JSON body example:

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

PersonUpdated

Data object:

Property	Type	Description
PersonId	Guid	The BrickId of the person.

JSON body example:

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

PowerOfAttorneyUpdated

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AgentId	Guid	The BrickId of the agent.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "PowerOfAttorneyUpdated",
  "Data": [
    {
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

SubscriptionOrderUpdated

Data object:

Property	Type	Description
SubscriptionOrderId	Guid	The BrickId of the order.

JSON body example:

{
  "Id": "e36ae9d6-36ac-44e2-8caa-e7689687a338",
  "EventName": "SubscriptionOrderUpdated",
  "Data": [
    {
      "SubscriptionOrderId": "9f8bb8fe-4d32-46e9-9c21-dd6784cf1a6b",
      "CreatedAtDateTime": "2021-03-31T09:32:32.9704405Z"
    }
  ]
}

TradeOrderUpdated

Data object:

Property	Type	Description
OrderId	Guid	The BrickId of the order.

JSON body example:

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

TransferOrderUpdated

Data object:

Property	Type	Description
OrderId	Guid	The BrickId of the order.

JSON body example:

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

TransferReceiverUpdated

Data object:

Property	Type	Description
PersonId	Guid	The BrickId of the person.

JSON body example:

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

ReservationUpdated

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AssetId	Guid	Teh BrickId of the asset.
ReservationId	Guid	The BrickId of the reservation.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ReservationUpdated",
  "Data": [
    {
      "ReservationId": "f8051803-d9ee-454c-8e80-89ef6dd8bc88",
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

RecurringOrderTemplateUpdated

Data object:

Property	Type	Description
OrderId	Guid	The BrickId of the recurring order template.

JSON body example:

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

PowerOfAttorneyDeleted

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AgentId	Guid	The BrickId of the agent.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "PowerOfAttorneyDeleted",
  "Data": [
    {
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

TransactionDeleted

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AssetId	Guid	The BrickId of the asset.
BusinessTransactionId	Guid	The BrickId of the business transaction.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "TransactionDeleted",
  "Data": [
    {
      "BusinessTransactionId": "21c5d670-8887-49aa-beed-a529086b1955",
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AssetId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}

ReservationDeleted

Data object:

Property	Type	Description
AccountId	Guid	The BrickId of the account.
AssetId	Guid	Teh BrickId of the asset.
ReservationId	Guid	The BrickId of the reservation.

JSON body example:

{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ReservationDeleted",
  "Data": [
    {
      "ReservationId": "f8051803-d9ee-454c-8e80-89ef6dd8bc88",
      "AccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}