marketingprogram

publishing marketingprogram events

Publish events by HTTP POST to your own pods /publish/ endpoint including the topic, recipient and message body.]

Example

POST /publish/ HTTP/1.1
Host: # { your pod host url }
x-api-key: # { your api key }
Content-Type: application/json

{
  "topic": "https://realestate/{topic}#{event}",
  "recipient": # the publishing pod,
  "@context": # optional transformation context,
  "data": {
    "type": "{Action}
  }

}

receiving marketingprogram events

Event	Description
realestate/marketingprogram#create	a marketing program has been created
realestate/marketingprogram#delete	a marketing program was deleted
realestate/marketingprogram#memberadd	a program member was added by the agent
realestate/marketingprogram#memberremove	a program member was removed by the agent

create

realestate/marketingprogram#create

a marketing program has been created

Schema

Name	Type	Description
topic	string!	the event topic which determines the schema of event.data
time	string<date-time>	date & time the event was produced
agent	string<uri>	the user,tema or organization who sent the event
instrument	string<uri>	the service which created the event
source	string<uri>	an agent, team or organization who received a copy of the event
originalRecipient	string<uri>	the original recipient of the event with this id
id	string<uri>	the shared identifier of the event, akd the event id
@id	string<uri>	the url of your instance of the event in your inbox
data	object!	the object was created by the agent
data.type	string!	CreateAction
data.object	object	A collection of pre-defined activities which take place over a period of time or in a regular, ongoing schedule. <br/>RANGE: MarketingProgram

Example

{
  "topic": "realestate/marketingprogram#create",
  "time": "2022-10-12T01:13:43Z",
  "agent": "https://agentid.example.com/profile/card#me",
  "instrument": "https://vendorid.example.com/profile/card#me",
  "source": "https://companyid.example.com/profile/card#me",
  "originalRecipient": "https://agentid.example.com/profile/card#me",
  "id": "https://instrumentid.example.com/publish/xxxxxxxxxxxxx",
  "@id": "https://yourpod.example.com/inbox/xxxxxxxxxxxxx",
  "data": {
    "type": "CreateAction",
    "object": {
      "type": "MarketingProgram",
      "name": "Market Activity Report 508 Homewood Ave",
      "identifier": {
        "salesforceContactID": "c28834ca-db69-4da8-90ad-75cdc9907298",
        "namespaceid": "xxxx"
      },
      "member": [
        {
          "type": "Person",
          "name": "John Smith",
          "identifier": {
            "buysideid": "ab123"
          }
        }
      ],
      "creator": "http://{user}.example.com/profile/card#me",
      "dateCreated": "2022-10-12T01:13:43Z",
      "dateModified": "2022-10-12T01:13:43Z",
      "about": {
        "type": "Place",
        "address": {
          "streetAddress": "508 Homewood Ave",
          "addressLocality": "Chula Vista",
          "addressRegion": "California",
          "postalCode": "55555"
        }
      }
    }
  }
}

delete

realestate/marketingprogram#delete

a marketing program was deleted

Schema

Name	Type	Description
topic	string!	the event topic which determines the schema of event.data
time	string<date-time>	date & time the event was produced
agent	string<uri>	the user,tema or organization who sent the event
instrument	string<uri>	the service which created the event
source	string<uri>	an agent, team or organization who received a copy of the event
originalRecipient	string<uri>	the original recipient of the event with this id
id	string<uri>	the shared identifier of the event, akd the event id
@id	string<uri>	the url of your instance of the event in your inbox
data	object!	object is removed by the agent from the targetCollection <br/>RANGE: DeleteAction
data.type	string!	the action type
data.object	object	A collection of pre-defined activities which take place over a period of time or in a regular, ongoing schedule.

Example

{
  "topic": "realestate/marketingprogram#delete",
  "time": "2022-10-12T01:13:43Z",
  "agent": "https://agentid.example.com/profile/card#me",
  "instrument": "https://vendorid.example.com/profile/card#me",
  "source": "https://companyid.example.com/profile/card#me",
  "originalRecipient": "https://agentid.example.com/profile/card#me",
  "id": "https://instrumentid.example.com/publish/xxxxxxxxxxxxx",
  "@id": "https://yourpod.example.com/inbox/xxxxxxxxxxxxx",
  "data": {
    "type": "DeleteAction",
    "object": {
      "type": "MarketingProgram",
      "identifier": {
        "namespaceid": "xxxx"
      }
    },
    "agent": "https://{user}.example.com/profile/card#me"
  }
}

memberadd

realestate/marketingprogram#memberadd

a program member was added by the agent

Schema

Name	Type	Description
topic	string!	the event topic which determines the schema of event.data
time	string<date-time>	date & time the event was produced
agent	string<uri>	the user,tema or organization who sent the event
instrument	string<uri>	the service which created the event
source	string<uri>	an agent, team or organization who received a copy of the event
originalRecipient	string<uri>	the original recipient of the event with this id
id	string<uri>	the shared identifier of the event, akd the event id
@id	string<uri>	the url of your instance of the event in your inbox
data	object!	data (object) is added by user (agent), optionally to the targetCollection <br/>RANGE: AddAction
data.type	string!	AddAction
data.object	object	describes membership relation between a member (Person) and a MarketingProgram <br/>RANGE: ProgramMembership
data.targetCollection	object	the collection or reference to the collection receiving the data <br/>RANGE: MarketingProgram

Example

{
  "topic": "realestate/marketingprogram#memberadd",
  "time": "2022-10-12T01:13:43Z",
  "agent": "https://agentid.example.com/profile/card#me",
  "instrument": "https://vendorid.example.com/profile/card#me",
  "source": "https://companyid.example.com/profile/card#me",
  "originalRecipient": "https://agentid.example.com/profile/card#me",
  "id": "https://instrumentid.example.com/publish/xxxxxxxxxxxxx",
  "@id": "https://yourpod.example.com/inbox/xxxxxxxxxxxxx",
  "data": {
    "type": "AddAction",
    "object": {
      "type": "ProgramMembership",
      "role": "Owner",
      "member": {
        "type": "Person",
        "name": "Edgardo Fisher",
        "identifier": {
          "aceid": "816fd12f-6479-4f45-b26f-0a2ba54972b6"
        }
      },
      "memberOf": {
        "type": "MarketingProgram",
        "name": "Market Activity Report 508 Homewood Ave",
        "identifier": {
          "aceid": "4ef1469a-1fc4-43af-96b1-0e4402ccc46e",
          "buysideid": "83271c2a-c35e-44e9-b790-5389f2c11b17"
        }
      }
    },
    "targetCollection": {
      "type": "MarketingProgram",
      "name": "Market Activity Report 508 Homewood Ave",
      "identifier": {
        "aceid": "4ef1469a-1fc4-43af-96b1-0e4402ccc46e",
        "buysideid": "83271c2a-c35e-44e9-b790-5389f2c11b17"
      }
    }
  }
}

memberremove

realestate/marketingprogram#memberremove

a program member was removed by the agent

Schema

Name	Type	Description
topic	string!	the event topic which determines the schema of event.data
time	string<date-time>	date & time the event was produced
agent	string<uri>	the user,tema or organization who sent the event
instrument	string<uri>	the service which created the event
source	string<uri>	an agent, team or organization who received a copy of the event
originalRecipient	string<uri>	the original recipient of the event with this id
id	string<uri>	the shared identifier of the event, akd the event id
@id	string<uri>	the url of your instance of the event in your inbox
data	object!	an object (object) is removed by a user (agent), optionally from a collection (targetCollection)
data.type	string!	the action type
data.object	object	describes membership relation between a member (Person) and a MarketingProgram <br/>RANGE: ProgramMembership
data.agent	*
data.targetCollection	*	the collection from which the item is being removed <br/>RANGE: MarketingProgram

Example

{
  "topic": "realestate/marketingprogram#memberremove",
  "time": "2022-10-12T01:13:43Z",
  "agent": "https://agentid.example.com/profile/card#me",
  "instrument": "https://vendorid.example.com/profile/card#me",
  "source": "https://companyid.example.com/profile/card#me",
  "originalRecipient": "https://agentid.example.com/profile/card#me",
  "id": "https://instrumentid.example.com/publish/xxxxxxxxxxxxx",
  "@id": "https://yourpod.example.com/inbox/xxxxxxxxxxxxx",
  "data": {
    "type": "RemoveAction",
    "object": {
      "type": "ProgramMembership",
      "role": "Owner",
      "member": {
        "type": "Person",
        "name": "Edgardo Fisher",
        "identifier": {
          "aceid": "816fd12f-6479-4f45-b26f-0a2ba54972b6"
        }
      }
    },
    "agent": "https://{user-who-removed-the-item}.com/profile/card#me",
    "targetCollection": {
      "type": "MarketingProgram",
      "name": "Market Activity Report 508 Homewood Ave",
      "identifier": {
        "aceid": "4ef1469a-1fc4-43af-96b1-0e4402ccc46e",
        "buysideid": "83271c2a-c35e-44e9-b790-5389f2c11b17"
      }
    }
  }
}