Message
a new team member (data.object) was added to an award team (data.targetCollection)
Payload Example(s) (generated)
{
"topic": "realestate/award#teammemberadd",
"data": {
"type": "AddAction",
"object": "http://example.com",
"targetCollection": {
"type": "AwardTeam",
"name": "Top Producer by Volume",
"identifier": {
"hsfTeamId": "xxxxx"
},
"member": [
"http://12345.example.com/profile/card#me"
]
}
}
}
Payload
| Name | Type | Description |
|---|
| (root) | object | - |
| topic | string | const ("realestate/award#teammemberadd") |
| data | object | - |
| data.type | string | const ("AddAction") |
| data.object | string | the profile uri of the team member being added format (uri) |
| data.targetCollection | object | a Collection |
| data.targetCollection.type | string | const ("AwardTeam") |
| data.targetCollection.name | string | - |
| data.targetCollection.identifier | object | 1 properties |
| data.targetCollection.member | array<string> | members of the AwardTeam |
| data.targetCollection.member (single item) | string | format (uri) |
| Name | Type | Description |
|---|
| (root) | object | - |
| time | string | date & time the event was produced format (date-time) |
| agent | string | if you are a multi-tenant app, then the agent is the user associated with the event data. any future events related to this message will be sent to the same agent/recipient format (uri) |
| instrument | string | the app or service that produced the event on behalf of the agent/user format (uri) |
| source | string | a copy of the event was sent to the source(s). format (uri) |
| originalRecipient | string | the originalRecipient helps you determine the subscription that delivered the event to you. if the originalRecipient is the same as the agent, then the you are subscribed to the agent. if the originalRecipient is different from the agent, then you are subscribed to the event source format (uri) |
| id | string | the Event ID (aka "Publish ID") is the immutable canonical identifier for the event. it is a URI that is unique to the event and will not change. all subscribers will receive the same id for the same event. format (uri) |
| @id | string | format (uri) |
Message tags
| Name | Description | Documentation |
|---|
| action|add | - | - |
| topic|award | - | - |
| domain|realestate | - | - |