Versions Compared

Old Version 22

changes.mady.by.user Carl Haglind

Saved on

compared with

New Version 23

changes.mady.by.user Simon Gullberg

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Expand
titleAccountCreated

Data object:

Property

Type

Description

AccountId

Guid

The BrickId of the account.

JSON body example:

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

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:

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

Data object:

Property

Type

Description

AllocationTemplateId

Guid

The BrickId of the allocation template.

JSON body example:

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

Data object:

Property

Type

Description

InstrumentId

Guid

The BrickId of the instrument.

JSON body example:

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

Data object:

Property

Type

Description

PersonId

Guid

The BrickId of the person.

JSON body example:

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

Data object:

Property

Type

Description

AccountId

Guid

The BrickId of the account.

AgentId

Guid

The BrickId of the agent.

JSON body example:

Code Block
languagejson
{
  "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"
    }
  ]
}
Expand
titleRecurringOrderTemplateCreated

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the recurring order template.

JSON body example:

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

Added in release 2.31

Data object:

Property

Type

Description

SubscriptionOrderId

Guid

The BrickId of the order.

JSON body example:

Code Block
languagejson
{
  "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"
    }
  ]
}
Expand
titleTradeOrderCreated

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the order.

JSON body example:

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

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:

Code Block
languagejson
{
  "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"
    }
  ]
}
Expand
titleTransferOrderCreated

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the order.

JSON body example:

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

Data object:

Property

Type

Description

PersonId

Guid

The BrickId of the person.

JSON body example:

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

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:

Code Block
languagejson
{
  "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"
    }
  ]
}
Expand
titleAccountUpdatedExternalFundBatchOrderCreated - Coming soon

Data object:

Property

Type

Description

AccountId

OrderId

Guid

The BrickId of the

account

order.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "AccountUpdatedExternalFundBatchOrderCreated",
  "Data": [
    {
      "AccountIdOrderId": "fbafd9dff8051803-f74fd9ee-4ef6454c-a4ed-5b604215ee03",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z8e80-89ef6dd8bc88"
    }
  ]
}

JSON body example:

Expand
titleActivityLogUpdatedFundBatchOrderCreated - Coming soon

Data object:

Property

Type

Description

ActivityLogId

OrderId

Guid

The BrickId of the

activity log.

TypeKey

string

The type of the activity log. TypeKey can be Message, Task or Note.

Code Block
languagejson

order.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ActivityLogUpdatedFundBatchOrderCreated",
  "Data": [
    {
      "ActivityLogIdOrderId": "fbafd9dff8051803-f74fd9ee-4ef6454c-a4ed8e80-5b604215ee0389ef6dd8bc88",
    }
 "TypeKey": "Message",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}
Expand
titleAllocationTemplateUpdated
 ]
}
Expand
titleCurrencyExchangeBatchOrderCreated - Coming soon

Data object:

Property

Type

Description

AllocationTemplateId

OrderId

Guid

The BrickId of the

allocation template

order.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ActivityLogUpdatedCurrencyExchangeBatchOrderCreated",
  "Data": [
    {
      "AllocationTemplateIdOrderId": "fbafd9dff8051803-f74fd9ee-4ef6454c-a4ed8e80-5b604215ee0389ef6dd8bc88",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"}
  ]
 }
  ]
}
Expand
titleInstrumentUpdatedAccountUpdated

Data object:

Property

Type

Description

InstrumentId

AccountId

Guid

The BrickId of the

instrument

account.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "InstrumentUpdatedAccountUpdated",
  "Data": [
    {
      "InstrumentIdAccountId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}
Expand
titlePersonUpdatedActivityLogUpdated

Data object:

Property

Type

Description

PersonId

ActivityLogId

Guid

The BrickId

of the person

of the activity log.

TypeKey

string

The type of the activity log. TypeKey can be Message, Task or Note.

JSON body example:

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

JSON JSON body example:

Expand
titlePowerOfAttorneyUpdatedAllocationTemplateUpdated

Data object:

Property

Type

Description

AccountId

AllocationTemplateId

Guid

The BrickId of the

account

allocation template.

AgentId

Guid

The BrickId of the agent.

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "PowerOfAttorneyUpdatedActivityLogUpdated",
  "Data": [
    {
      "AccountIdAllocationTemplateId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}
Added in release 2.31
Expand
titleSubscriptionOrderUpdated
InstrumentUpdated

Data object:

Property

Type

Description

SubscriptionOrderId

InstrumentId

Guid

The BrickId of the

order

instrument.

JSON body example:

Code Block
languagejson
{
  "Id": "e36ae9d64a92ced3-36ac49fd-44e24ec4-8caaab4f-e7689687a338b1dce978da7f",
  "EventName": "SubscriptionOrderUpdatedInstrumentUpdated",
  "Data": [
    {
      "SubscriptionOrderIdInstrumentId": "9f8bb8fefbafd9df-4d32f74f-46e94ef6-9c21a4ed-dd6784cf1a6b5b604215ee03",
      "CreatedAtDateTime": "20212020-0311-31T0930T06:3259:3253.9704405Z7972377Z"
    }
  ]
}
Expand
titleTradeOrderUpdatedPersonUpdated

Data object:

Property

Type

Description

OrderId

PersonId

Guid

The BrickId of the

order

person.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "TradeOrderUpdatedPersonUpdated",
  "Data": [
    {
      "OrderIdPersonId": "fbafd9df-f74f-4ef6-a4ed-5b604215ee03",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z"
    }
  ]
}
Expand
titleTransferOrderUpdatedPowerOfAttorneyUpdated

Data object:

Property

Type

Description

OrderId

AccountId

Guid

The BrickId of the account.

AgentId

Guid

The BrickId of the

order

agent.

JSON body example:

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

Added in release 2.31

Data object:

Property

Type

Description

PersonId

SubscriptionOrderId

Guid

The BrickId of the

person

order.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3e36ae9d6-49fd36ac-4ec444e2-ab4f8caa-b1dce978da7fe7689687a338",
  "EventName": "TransferReceiverUpdatedSubscriptionOrderUpdated",
  "Data": [
    {
      "PersonIdSubscriptionOrderId": "fbafd9df9f8bb8fe-f74f4d32-4ef646e9-a4ed9c21-5b604215ee03dd6784cf1a6b",
      "CreatedAtDateTime": "20202021-1103-30T0631T09:5932:5332.7972377Z9704405Z"
    }
  ]
}

JSON body example:

{

JSON body example:

Expand
titleReservationUpdatedTradeOrderUpdated

Data object:

Property

Type

Description

AccountId

OrderId

Guid

The BrickId of the

account

order.

AssetId

Guid

Teh BrickId of the asset.

ReservationId

Guid

The BrickId of the reservation.

Code Block
languagejson
Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ReservationUpdatedTradeOrderUpdated",
  "Data": [
    {
      "ReservationIdOrderId": "f8051803fbafd9df-d9eef74f-454c4ef6-8e80a4ed-89ef6dd8bc885b604215ee03",
      "AccountIdCreatedAtDateTime": "fbafd9df2020-f74f-4ef6-a4ed-5b604215ee03",11-30T06:59:53.7972377Z"
    }
  "AgentId": "f351e163-02ce-4ce7-b911-fe0ccf840748",]
}
Expand
titleTransferOrderUpdated

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the order.

JSON body example:

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

Data object:

Property

Type

Description

PersonId

Guid

The BrickId of the person.

JSON body example:

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

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:

Code Block
languagejson
{
  "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"
    }
  ]
}
Expand
titleRecurringOrderTemplateUpdated

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the recurring order template.

JSON body example:

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

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the order.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "FundBatchOrderUpdated",
  "Data": [
    {
      "OrderId": "f8051803-d9ee-454c-8e80-89ef6dd8bc88"
    }
  ]
}
Expand
titleExternalFundBatchOrderUpdated - Coming soon

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the order.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "ExternalFundBatchOrderUpdated",
  "Data": [
    {
      "CreatedAtDateTimeOrderId": "2020-11-30T06:59:53.7972377Zf8051803-d9ee-454c-8e80-89ef6dd8bc88"
    }
  ]
}
Expand
titleRecurringOrderTemplateUpdatedCurrencyExchangeBatchOrderUpdated - Coming soon

Data object:

Property

Type

Description

OrderId

Guid

The BrickId of the

recurring

order

template

.

JSON body example:

Code Block
languagejson
{
  "Id": "4a92ced3-49fd-4ec4-ab4f-b1dce978da7f",
  "EventName": "RecurringOrderTemplateUpdatedCurrencyExchangeBatchOrderUpdated",
  "Data": [
    {
      "OrderId": "fbafd9dff8051803-f74fd9ee-4ef6454c-a4ed-5b604215ee03",
      "CreatedAtDateTime": "2020-11-30T06:59:53.7972377Z8e80-89ef6dd8bc88"
    }
  ]
}
Expand
titlePowerOfAttorneyDeleted

Data object:

Property

Type

Description

AccountId

Guid

The BrickId of the account.

AgentId

Guid

The BrickId of the agent.

JSON body example:

Code Block
languagejson
{
  "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"
    }
  ]
}
Expand
titleTransactionDeleted

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:

Code Block
languagejson
{
  "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"
    }
  ]
}
Expand
titleReservationDeleted

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:

Code Block
languagejson
{
  "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"
    }
  ]
}