ec.amqp 0.10.1 documentation

ec.amqp 0.10.1

This documents all events and commands used in entrecode systems.

#PublicAPI
#DataManager
#Mail/Push Commands
#ec.Tasks
#AppServer
#Account Server Notifications
#Customer: DSB
#Customer: Dealbunny

Servers

cluster1.entrecode.deamqpproduction
This is the entrecode RabbitMQ broker.
cluster1.cachena.entrecode.deamqpstage
This is the entrecode RabbitMQ broker, staging version.

Operations

SUB /{shortID}/{modelTitle}/{entryID}/{entryEventType}
a Data Manager entry was created, updated or deleted.
It also contains info about which content has changed on entryUpdated events.
Example:

amqp.workerQueue( // or amqp.subscribe( 'myService', 'publicAPI', ['035af82b.mymodel.*.entryCreated'], // all created entries in mymodel async (event, properties, {ack, nack}) => { const eventType = properties.type; // event is parsed payload ack(); // always call ack() or nack() nack(10000, true) // call nack after timeout of 10 seconds. This is also the default. Second parameter requeue (default is `false` in contrast to amqplib native behavior), third parameter redirect queue (for dead-letter queues) }, 1 // prefetch (default 1) );
Operation IDentrySub
shortID
required
string
must match: ^[0-9a-f]{8}$uid: shortID
Short ID of the data manager

modelTitle
required
string
uid: modelTitle
Title of the model

entryID
required
string
must match: ^[0-9A-Za-z-_]{7,14}$uid: entryID
ID of the entry

entryEventType
required
string
uid: entryEventType
type of the entry event

Allowed values:
"entryCreated"
"entryUpdated"
"entryDeleted"
is
routingKey
name
publicAPI
type
topic
durable
true
vhost
/
- #PublicAPI
Accepts the following message:
PublicAPIEntryEvent
object
entryID
string
must match: ^[0-9A-Za-z-_]{7,14}$uid: entryID
ID of the entry

modelID
string
format: uuid
ID of the model

modelTitle
string
uid: modelTitle
Title of the model

dataManagerID
string
format: uuid
ID of the data manager

shortID
string
must match: ^[0-9a-f]{8}$uid: shortID
Short ID of the data manager

object
entry content

_creator
string
format: uuid
ID of the creator

Additional properties are allowed.
object
old entry content, on entryUpdated events

Additional properties are allowed.
array<object>
object
Additional properties are allowed.
array<object>
object
Additional properties are allowed.
array<object>
object
Additional properties are allowed.
object
accountID
string
format: uuid
userType
string
Allowed values:
"publicUser"
"dmUser"
Additional properties are allowed.
modified
string
format: datetime
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"entryUpdated"
appId
string
shortID

timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "entryID": "string", "modelID": "17448b37-e359-404a-84aa-35f10765ba44", "modelTitle": "string", "dataManagerID": "dba79ff2-db90-4156-8969-c0f6dc76730c", "shortID": "string", "data": { "_creator": "dd507a84-c3d7-47c6-a816-b22bbf6fb4a5" }, "oldEntryData": {}, "entryAndAssetRelations": [ {} ], "roleRelations": [ {} ], "uniqueFields": [ {} ], "user": { "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9", "userType": "publicUser" }, "modified": "string" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "entryUpdated", "appId": "string", "timestamp": "string" }

This example has been generated automatically.
SUB /{shortID}/_assets/{assetGroupID}/{assetID}/{assetEventType}
an asset was created, updated or deleted.

Operation IDassetSub
shortID
required
string
must match: ^[0-9a-f]{8}$uid: shortID
Short ID of the data manager

assetGroupID
required
string
uid: assetGroupID
Title of the asset Group

assetID
required
any
ID of the entry

assetEventType
required
string
uid: assetEventType
type of the asset event

Allowed values:
"assetCreated"
"assetUpdated"
"assetDeleted"
is
routingKey
name
publicAPI
type
topic
durable
true
vhost
/
- #PublicAPI
Accepts the following message:
PublicAPIAssetEvent
object
object
full created asset object (only on assetCreated).

assetID
string
ID of the asset (encoded UUID)

assetGroupID
string
ID of the assetGroup, arbitrary string.

object
filename
string
size
number
object
width
number
height
number
Additional properties are allowed.
Additional properties are allowed.
duplicates
number
dataManagerID
string
format: uuid
ID of the data manager

array<any>
usually empty array because fileVariants are generated after creation

isUsed
boolean
type
string
ec asset type

Allowed values:
"image"
"video"
"audio"
"plain"
"document"
"spreadsheet"
"archive"
"other"
title
string
mimetype
string
creator
string
format: uuid
creatorType
string
Allowed values:
"publicUser"
"dmUser"
created
string
format: datetime
array<any>
caption
string
usually empty string, because it cannot be set on creation

hash
string
Additional properties are allowed.
assetID
string
ID of the asset (encoded UUID) (not on assetCreated)

object
updated values (only on assetUpdated)

Additional properties are allowed.
object
old values of updated values (only on assetUpdated)

Additional properties are allowed.
accountID
required
string
format: uuid
userType
required
string
Allowed values:
"publicUser"
"dmUser"
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"assetUpdated"
appId
string
shortID

timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "asset": { "assetID": "fGcaWvdPQhqkmrxvjirsIw", "assetGroupID": "string", "file": { "filename": "string", "size": 0, "resolution": { "width": 0, "height": 0 } }, "duplicates": 0, "dataManagerID": "dba79ff2-db90-4156-8969-c0f6dc76730c", "fileVariants": [], "isUsed": true, "type": "image", "title": "string", "mimetype": "string", "creator": "1dccd4a6-75d2-43aa-a088-76d941f1b60a", "creatorType": "publicUser", "created": "string", "thumbnails": [], "caption": "string", "hash": "string" }, "assetID": "fGcaWvdPQhqkmrxvjirsIw", "updatedValues": {}, "oldValues": {}, "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9", "userType": "publicUser" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "assetUpdated", "appId": "string", "timestamp": "string" }

This example has been generated automatically.
SUB /{shortID}/_auth/{accountID}/loggedIn
a DM User has logged in / got a new access token

Operation IDloggedInSub
shortID
required
string
must match: ^[0-9a-f]{8}$uid: shortID
Short ID of the data manager

accountID
required
string
format: uuiduid: accountID
Data Manager User Account ID

is
routingKey
name
publicAPI
type
topic
durable
true
vhost
/
- #PublicAPI
Accepts the following message:
PublicAPIUserLoggedInEvent
object
accountID
string
format: uuid
issued
number
validUntil
number
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"loggedIn"
appId
string
shortID

timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9", "issued": 0, "validUntil": 0 }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "loggedIn", "appId": "string", "timestamp": "string" }

This example has been generated automatically.
SUB /{dataManagerID}/{dataManagerEventType}
a data manager was created or updated.

Operation IDdatamanagerSub
dataManagerID
required
string
format: uuiduid: dataManagerID
UUID of the Data Manager

dataManagerEventType
required
string
uid: dataManagerEventType
type of the dm event. There is no event for Deletion!

Allowed values:
"datamanagerCreated"
"datamanagerUpdated"
is
routingKey
name
ecAPI
type
topic
durable
true
vhost
/
- #DataManager
Accepts the following message:
ecAPIDataManagerEvent
Settings of the created or updated data manager. Note that old values are not available on update events.

object
dataManagerID
string
format: uuiduid: dataManagerID
UUID of the Data Manager

shortID
string
must match: ^[0-9a-f]{8}$
Short ID of the data manager

title
string
description
string
object
Additional properties are allowed.
hexColor
string
must match: ^#[0-9a-f]{6}$
defaultLocale
string
array<any>
array<any>
customerID
any
dbhost
any
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"datamanagerCreated"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "dataManagerID": "dba79ff2-db90-4156-8969-c0f6dc76730c", "shortID": "string", "title": "string", "description": "string", "config": {}, "hexColor": "string", "defaultLocale": "string", "locales": [], "publicAssetRights": [], "customerID": null, "dbhost": null }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "datamanagerCreated", "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "timestamp": "string" }

This example has been generated automatically.
SUB /{dataManagerID}/{modelID}/{modelEventType}
a model was created, updated or deleted.

Operation IDmodelSub
dataManagerID
required
string
format: uuiduid: dataManagerID
UUID of the Data Manager

modelID
required
string
format: uuiduid: modelID
UUID of the Model

modelEventType
required
string
uid: modelEventType
type of the model event

Allowed values:
"modelCreated"
"modelUpdated"
"modelDeleted"
is
routingKey
name
ecAPI
type
topic
durable
true
vhost
/
- #DataManager
Accepts the following message:
ecAPIModelEvent
object
modelID
string
format: uuiduid: modelID
UUID of the Model

title
string
description
string
hexColor
string
must match: ^#[0-9a-f]{6}$
titleField
string
array<object>
object
Additional properties are allowed.
array<any>
array<any>
array<any>
object
Additional properties are allowed.
dataManagerID
string
format: uuiduid: dataManagerID
UUID of the Data Manager

shortID
string
must match: ^[0-9a-f]{8}$
Short ID of the data manager

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"modelCreated"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "modelID": "17448b37-e359-404a-84aa-35f10765ba44", "title": "string", "description": "string", "hexColor": "string", "titleField": "string", "fields": [ {} ], "locales": [], "hooks": [], "sync": [], "config": {}, "dataManagerID": "dba79ff2-db90-4156-8969-c0f6dc76730c", "shortID": "string" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "modelCreated", "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "timestamp": "string" }

This example has been generated automatically.
SUB /{dataManagerID}/{assetGroupID}/{assetgroupEventType}
an assetgroup was created or updated.

Operation IDassetgroupSub
dataManagerID
required
string
format: uuiduid: dataManagerID
UUID of the Data Manager

assetGroupID
required
restricted any
must match: ^((?!^image$|^video$|^audio$|^plain$|^document$|^spreadsheet$|^archive$)[a-z0-9_-]{1,32})$[ 1 .. 32 ] charactersuid: assetGroupID
ID/title of the assetgroup

assetgroupEventType
required
string
uid: assetgroupEventType
type of the assetgroup event

Allowed values:
"assetgroupCreated"
"assetgroupUpdated"
is
routingKey
name
ecAPI
type
topic
durable
true
vhost
/
- #DataManager
Accepts the following message:
ecAPIAssetGroupEvent
object
accountID
string
format: uuid
accountID of the user who triggered this event

object
full created assetgroup object (only on assetgroupCreated events)

assetGroupID
restricted any
must match: ^((?!^image$|^video$|^audio$|^plain$|^document$|^spreadsheet$|^archive$)[a-z0-9_-]{1,32})$[ 1 .. 32 ] charactersuid: assetGroupID
The unique ID of the asset group (and also the name)

public
boolean
Read-only field indicating if assets in this group are generally public

object
Additional properties are allowed.
array<object>
object
Additional properties are allowed.
Additional properties are allowed.
object
updated values of the assetgroup (only on assetgroupUpdated events)

Additional properties are allowed.
object
previous values of updated assetgroup values (only on assetgroupUpdated events)

Additional properties are allowed.
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"assetgroupCreated"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9", "assetGroup": { "assetGroupID": "string", "public": true, "settings": {}, "policies": [ {} ] }, "updatedValues": {}, "oldValues": {} }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "assetgroupCreated", "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "timestamp": "string" }

This example has been generated automatically.
SUB /{dataManagerID}/account/{accountID}/deleted
an DM Account was deleted
Note that there are currently no events for created or updated DM Accounts.
Also, there are no events for ec.AccountServer Accounts (ec-Accounts).

Operation IDaccountSub
dataManagerID
required
string
format: uuiduid: dataManagerID
UUID of the Data Manager

accountID
required
string
format: uuiduid: accountID
ID/title of the assetgroup

is
routingKey
name
ecAPI
type
topic
durable
true
vhost
/
- #DataManager
Accepts the following message:
ecAPIAccountEvent
object
accountID
string
format: uuiduid: accountID
accountID of the deleted account

dataManagerID
string
format: uuiduid: dataManagerID
UUID of the Data Manager

email
string
format: email
pending
boolean
created
string
format: datetime
pendingUpdated
string
format: datetime
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"accountDeleted"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9", "dataManagerID": "dba79ff2-db90-4156-8969-c0f6dc76730c", "email": "user@example.com", "pending": true, "created": "string", "pendingUpdated": "string" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "accountDeleted", "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "timestamp": "string" }

This example has been generated automatically.
PUB /cmd/sendMail/mailgun/{domain}
send an E-Mail via ec.mail (mailgun)

Operation IDsendMailMailgunPub
domain
required
string
uid: domain
mail domain to use

Default value:"entrecode.de"
persistent
true
timestamp
true
ack
true
name
mail
type
topic
durable
true
vhost
/
- #Mail/Push Commands
Accepts the following message:
MailMailgunCommand
object
object
oneOf
Default value:"undisclosed-recipients:; <no-reply@${domain}>"
Adheres to:
string
Recipient(s) in mailgun-compatible format

array<string>
Items:
string
Recipient(s) in mailgun-compatible format

oneOf
Adheres to:
string
Recipient(s) in mailgun-compatible format

array<string>
Items:
string
Recipient(s) in mailgun-compatible format

oneOf
Adheres to:
string
Recipient(s) in mailgun-compatible format

array<string>
Items:
string
Recipient(s) in mailgun-compatible format

from
string
Sender address in mailgun-compatible format. Domain part must be equal to domain.

h:Reply-To
string
Reply-To address in mailgun-compatible format

subject
string
mail subject

text
string
plain text content. Can be omitted if html is set, because it is then generated out of the html content.

html
string
main mail content as html. CSS etc. will be inlined automatically.

array<string>
Items:
string
format: uri
templateSet
string
ec.mail template set, default is empty string (no template set)

Default value:""
template
string
ec.mail template name, do not use together with mailgunTemplate

language
string
language identifier, if using ec.mail templates

object
variable data for ec.mail templates

Additional properties are allowed.
mailgunTemplate
string
native mailgun template name, do not use together with ec.mail templates.

h:X-Mailgun-Variables
string
if using mailgunTemplate: a valid JSON-encoded dictionary used as the input for template variable expansion

o:tag
string
o:deliverytime
string
Desired time of delivery. Note: Messages can be scheduled for a maximum of 3 days in the future.

Additional properties are allowed.
domain
string
uid: domain
Default value:"entrecode.de"
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"cmd.sendMail"
appId
string
domain

timestamp
number
Additional properties are allowed.
Examples
{ "mail": { "to": "undisclosed-recipients:; <no-reply@${domain}>", "cc": "Reci Pient <recipient@somewhere.com>", "bcc": "Reci Pient <recipient@somewhere.com>", "from": "entrecode <ec.mail@entrecode.de>", "h:Reply-To": "Reci Pient <recipient@somewhere.com>", "subject": "string", "text": "string", "html": "string", "attachment": [ "http://example.com" ], "templateSet": "", "template": "string", "language": "string", "data": {}, "mailgunTemplate": "string", "h:X-Mailgun-Variables": "string", "o:tag": "string", "o:deliverytime": "Thu, 13 Oct 2025 18:02:00 +0000" }, "domain": "entrecode.de" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "cmd.sendMail", "appId": "string", "timestamp": 0 }

This example has been generated automatically.
PUB /cmd/sendPush/hector/{appsiteID}
send a push notification for Hector Appsites via Firebase

Operation IDsendPushHectorPub
appsiteID
required
string
format: uuiduid: appsiteID
appsiteID to use (for firebase config)

persistent
true
timestamp
true
ack
true
name
mail
type
topic
durable
true
vhost
/
- #Mail/Push Commands
Accepts the following message:
PushHectorCommand
object
appsiteID
string
format: uuiduid: appsiteID
restricted any
title
required
string
body
string
bodyLong
string
for longer message in firebase db

messageType
string
object
Additional properties are allowed.
from
string
fromCustomerId
string
array<string>
Items:
string
format: uuid
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"cmd.sendPush"
appId
string
appsiteID

timestamp
number
Additional properties are allowed.
Examples
{ "appsiteID": "ac4e77da-5daf-4631-a7dd-f566d53243ac", "notification": { "title": "string", "body": "string", "bodyLong": "string", "messageType": "string", "data": {}, "from": "string", "fromCustomerId": "string" }, "accountIDs": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "cmd.sendPush", "appId": "string", "timestamp": 0 }

This example has been generated automatically.
PUB /cmd/task/{task}
start an ec.task. Available tasks are output from ec.tasks API: https://ec-tasks.entrecode.de/

Operation IDecTaskCommand
task
required
string
uid: task
task identifier

persistent
true
timestamp
true
ack
true
name
ec.tasks
type
topic
durable
true
vhost
/
- #ec.Tasks
Accepts the following message:
ecTaskCommand
object
payload is depending on the task

commandID
string
_accountID
string
format: uuid
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
task name

appId
string
Default value:"ec.tasks-api"
timestamp
number
Additional properties are allowed.
Examples
{ "commandID": "string", "_accountID": "41d7413d-ef79-4df2-9eca-21cb121577e4" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "string", "appId": "ec.tasks-api", "timestamp": 0 }

This example has been generated automatically.
PUB /build/{platformType}/run
start a build at ec.appserver

Operation IDappserverBuildCommand
platformType
required
string
uid: platformType
platformType lowercased

persistent
true
timestamp
true
ack
true
name
appserverBuild
type
topic
durable
true
vhost
/
- #AppServer
Accepts the following message:
AppServerBuildCommand
object
platform object

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
timestamp
number
Additional properties are allowed.
Examples
{}

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "timestamp": 0 }

This example has been generated automatically.
SUB /build/{platformType}/buildEvent
an event produced by a running build

Operation IDappserverBuildEvent
platformType
required
string
uid: platformType
platformType lowercased

is
routingKey
name
appserverBuildEvents
type
topic
durable
true
vhost
/
- #AppServer
Accepts the following message:
AppServerBuildEvent
object
uuid
string
format: uuid
timestamp
string
format: datetime
message
string
temporary
boolean
object
Additional properties are allowed.
buildID
string
deploymentID
string
eventType
string
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
timestamp
number
Additional properties are allowed.
Examples
{ "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "timestamp": "string", "message": "string", "temporary": true, "info": {}, "buildID": "string", "deploymentID": "string", "eventType": "string" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "timestamp": 0 }

This example has been generated automatically.
SUB /build/{platformType}/buildResult
an event produced by a finished build

Operation IDappserverBuildResult
platformType
required
string
uid: platformType
platformType lowercased

is
routingKey
name
appserverBuildEvents
type
topic
durable
true
vhost
/
- #AppServer
Accepts the following message:
AppServerBuildResult
object
result
string
Allowed values:
"success"
"error"
buildID
string
timestamp
string
format: datetime
content
any
result of build or error

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
timestamp
number
Additional properties are allowed.
Examples
{ "result": "success", "buildID": "string", "timestamp": "string", "content": null }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "timestamp": 0 }

This example has been generated automatically.
SUB /ecAuth/permissionsUpdated
Permissions of an ec.account were changed

Operation IDecAuthPermissionsUpdated
is
routingKey
name
ecAuthNotifications
type
fanout
durable
true
vhost
/
- #Account Server Notifications
Accepts the following message:
ecAuthPermissionsUpdated
object
accountID
string
format: uuid
accountID whose permissions were changed

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"permissionsUpdated"
appId
string
Allowed values:
"ecAuth"
timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "permissionsUpdated", "appId": "ecAuth", "timestamp": "string" }

This example has been generated automatically.
SUB /ecAuth/tokenRevoked
An auth token was revoked

Operation IDecAuthTokenRevoked
is
routingKey
name
ecAuthNotifications
type
fanout
durable
true
vhost
/
- #Account Server Notifications
Accepts the following message:
ecAuthTokenRevoked
object
token
string
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"tokenRevoked"
appId
string
Allowed values:
"ecAuth"
timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "token": "string" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "tokenRevoked", "appId": "ecAuth", "timestamp": "string" }

This example has been generated automatically.
SUB /eva_webhook_events/{eventType}
Subscribe to an DSB EVA webhook event

Operation IDdsbEvaWebhookEventSub
eventType
required
string
uid: eventType
currently only abo_renewed is implemented

Default value:"abo_renewed"
is
routingKey
name
dsb-eva
type
topic
durable
true
vhost
/
- #Customer: DSB
Accepts the following message:
DSBEvaWebhookEvent
object
franchise
string
seoTitle

subject
string
usually booking entryID

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
uid: eventType
currently only abo_renewed is implemented

Default value:"abo_renewed"
timestamp
string
format: datetime
Additional properties are allowed.
Examples
{ "franchise": "string", "subject": "string" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "abo_renewed", "timestamp": "string" }

This example has been generated automatically.
SUB /deal/published/{dealID}
A new Deal is published

Operation IDdealbunnyDealPublished
dealID
required
any
ID of the newly published Deal

is
routingKey
name
dealbunny
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
SUB /{accountID}/seen
An Account has seen its activities

Operation IDdealbunnyAccountSeen
accountID
required
any
ID of the Account producing this event

is
routingKey
name
dealbunny
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
SUB /{accountID}/{dealAction}/{dealID}
An Account has done something on a deal

Operation IDdealbunnyDealAction
accountID
required
any
ID of the Account producing this event

dealAction
required
string
uid: dealAction
Allowed values:
"createdDeal"
"likedDeal"
"unlikedDeal"
dealID
required
any
ID of the deal the action was performed on
is
routingKey
name
dealbunny
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
SUB /{accountID}/postedComment/{dealID}{/replyTo}{/parentComment}
An Account has posted a comment

Operation IDdealbunnyPostCommentAction
accountID
required
any
ID of the Account producing this event

dealID
required
any
ID of the deal the comment was created on

/replyTo
required
string
uid: /replyTo
set to 'replyTo' if parentComment is set^

Allowed values:
"replyTo"
/parentComment
required
any
uid: /parentComment
a parent comment ID, if this is a reply comment
is
routingKey
name
dealbunny
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
SUB /{accountID}/{commentAction}/{commentID}
An Account has done something on a comment

Operation IDdealbunnyCommentAction
accountID
required
any
ID of the Account producing this event

commentAction
required
string
uid: commentAction
Allowed values:
"likedDealComment"
"dislikedDealComment"
"undislikedDealComment"
"unlikedDealComment"
commentID
required
any
ID of the comment the action was performed on
is
routingKey
name
dealbunny
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
SUB /{accountID}/redeemedReward/{rewardID}
An Account redeemed a reward

Operation IDdealbunnyRewardRedeem
accountID
required
any
ID of the Account producing this event

rewardID
required
any
ID of the reward that was redeemed

is
routingKey
name
dealbunny
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
PUB /expo/dealbunny/ticket
create a Dealbunny Expo Push Ticket

Operation IDdealbunnyExpoTicket
is
routingKey
name
expopush
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
<anonymous-message-23>
object
ticket
string
object
Additional properties are allowed.
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
expoTicket

appId
string
Default value:"deal.push"
timestamp
number
Additional properties are allowed.
Examples
{ "ticket": "string", "message": {} }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "string", "appId": "deal.push", "timestamp": 0 }

This example has been generated automatically.
PUB /expo/dealbunny/deleteMessageToken
command to delete a dealbunny Expo Push Message Token

Operation IDdealbunnyDeleteMessageTokenCommand
is
routingKey
name
expopush
type
topic
durable
true
vhost
/
- #Customer: Dealbunny
Accepts the following message:
<anonymous-message-24>
object
messageToken
string
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
messageToken

appId
string
Default value:"deal.push"
timestamp
number
Additional properties are allowed.
Examples
{ "messageToken": "string" }

This example has been generated automatically.
{ "persistent": true, "contentType": "application/json", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "type": "string", "appId": "deal.push", "timestamp": 0 }

This example has been generated automatically.

Messages

#1PublicAPIEntryEvent
object
entryID
string
must match: ^[0-9A-Za-z-_]{7,14}$uid: entryID
ID of the entry

modelID
string
format: uuid
ID of the model

modelTitle
string
uid: modelTitle
Title of the model

dataManagerID
string
format: uuid
ID of the data manager

shortID
string
must match: ^[0-9a-f]{8}$uid: shortID
Short ID of the data manager

object
entry content

_creator
string
format: uuid
ID of the creator

Additional properties are allowed.
object
old entry content, on entryUpdated events

Additional properties are allowed.
array<object>
object
Additional properties are allowed.
array<object>
object
Additional properties are allowed.
array<object>
object
Additional properties are allowed.
object
accountID
string
format: uuid
userType
string
Allowed values:
"publicUser"
"dmUser"
Additional properties are allowed.
modified
string
format: datetime
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"entryUpdated"
appId
string
shortID

timestamp
string
format: datetime
Additional properties are allowed.
#2PublicAPIAssetEvent
object
object
full created asset object (only on assetCreated).

assetID
string
ID of the asset (encoded UUID)

assetGroupID
string
ID of the assetGroup, arbitrary string.

object
filename
string
size
number
object
width
number
height
number
Additional properties are allowed.
Additional properties are allowed.
duplicates
number
dataManagerID
string
format: uuid
ID of the data manager

array<any>
usually empty array because fileVariants are generated after creation

isUsed
boolean
type
string
ec asset type

Allowed values:
"image"
"video"
"audio"
"plain"
"document"
"spreadsheet"
"archive"
"other"
title
string
mimetype
string
creator
string
format: uuid
creatorType
string
Allowed values:
"publicUser"
"dmUser"
created
string
format: datetime
array<any>
caption
string
usually empty string, because it cannot be set on creation

hash
string
Additional properties are allowed.
assetID
string
ID of the asset (encoded UUID) (not on assetCreated)

object
updated values (only on assetUpdated)

Additional properties are allowed.
object
old values of updated values (only on assetUpdated)

Additional properties are allowed.
accountID
required
string
format: uuid
userType
required
string
Allowed values:
"publicUser"
"dmUser"
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"assetUpdated"
appId
string
shortID

timestamp
string
format: datetime
Additional properties are allowed.
#3PublicAPIUserLoggedInEvent
object
accountID
string
format: uuid
issued
number
validUntil
number
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"loggedIn"
appId
string
shortID

timestamp
string
format: datetime
Additional properties are allowed.
#4ecAPIDataManagerEvent
Settings of the created or updated data manager. Note that old values are not available on update events.

object
dataManagerID
string
format: uuiduid: dataManagerID
UUID of the Data Manager

shortID
string
must match: ^[0-9a-f]{8}$
Short ID of the data manager

title
string
description
string
object
Additional properties are allowed.
hexColor
string
must match: ^#[0-9a-f]{6}$
defaultLocale
string
array<any>
array<any>
customerID
any
dbhost
any
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"datamanagerCreated"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
#5ecAPIModelEvent
object
modelID
string
format: uuiduid: modelID
UUID of the Model

title
string
description
string
hexColor
string
must match: ^#[0-9a-f]{6}$
titleField
string
array<object>
object
Additional properties are allowed.
array<any>
array<any>
array<any>
object
Additional properties are allowed.
dataManagerID
string
format: uuiduid: dataManagerID
UUID of the Data Manager

shortID
string
must match: ^[0-9a-f]{8}$
Short ID of the data manager

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"modelCreated"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
#6ecAPIAssetGroupEvent
object
accountID
string
format: uuid
accountID of the user who triggered this event

object
full created assetgroup object (only on assetgroupCreated events)

assetGroupID
restricted any
must match: ^((?!^image$|^video$|^audio$|^plain$|^document$|^spreadsheet$|^archive$)[a-z0-9_-]{1,32})$[ 1 .. 32 ] charactersuid: assetGroupID
The unique ID of the asset group (and also the name)

public
boolean
Read-only field indicating if assets in this group are generally public

object
Additional properties are allowed.
array<object>
object
Additional properties are allowed.
Additional properties are allowed.
object
updated values of the assetgroup (only on assetgroupUpdated events)

Additional properties are allowed.
object
previous values of updated assetgroup values (only on assetgroupUpdated events)

Additional properties are allowed.
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"assetgroupCreated"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
#7ecAPIAccountEvent
object
accountID
string
format: uuiduid: accountID
accountID of the deleted account

dataManagerID
string
format: uuiduid: dataManagerID
UUID of the Data Manager

email
string
format: email
pending
boolean
created
string
format: datetime
pendingUpdated
string
format: datetime
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"accountDeleted"
appId
string
format: uuid
dataManagerID

timestamp
string
format: datetime
Additional properties are allowed.
#8MailMailgunCommand
object
object
oneOf
Default value:"undisclosed-recipients:; <no-reply@${domain}>"
Adheres to:
string
Recipient(s) in mailgun-compatible format

array<string>
Items:
string
Recipient(s) in mailgun-compatible format

oneOf
Adheres to:
string
Recipient(s) in mailgun-compatible format

array<string>
Items:
string
Recipient(s) in mailgun-compatible format

oneOf
Adheres to:
string
Recipient(s) in mailgun-compatible format

array<string>
Items:
string
Recipient(s) in mailgun-compatible format

from
string
Sender address in mailgun-compatible format. Domain part must be equal to domain.

h:Reply-To
string
Reply-To address in mailgun-compatible format

subject
string
mail subject

text
string
plain text content. Can be omitted if html is set, because it is then generated out of the html content.

html
string
main mail content as html. CSS etc. will be inlined automatically.

array<string>
Items:
string
format: uri
templateSet
string
ec.mail template set, default is empty string (no template set)

Default value:""
template
string
ec.mail template name, do not use together with mailgunTemplate

language
string
language identifier, if using ec.mail templates

object
variable data for ec.mail templates

Additional properties are allowed.
mailgunTemplate
string
native mailgun template name, do not use together with ec.mail templates.

h:X-Mailgun-Variables
string
if using mailgunTemplate: a valid JSON-encoded dictionary used as the input for template variable expansion

o:tag
string
o:deliverytime
string
Desired time of delivery. Note: Messages can be scheduled for a maximum of 3 days in the future.

Additional properties are allowed.
domain
string
uid: domain
Default value:"entrecode.de"
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"cmd.sendMail"
appId
string
domain

timestamp
number
Additional properties are allowed.
#9PushHectorCommand
object
appsiteID
string
format: uuiduid: appsiteID
restricted any
title
required
string
body
string
bodyLong
string
for longer message in firebase db

messageType
string
object
Additional properties are allowed.
from
string
fromCustomerId
string
array<string>
Items:
string
format: uuid
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"cmd.sendPush"
appId
string
appsiteID

timestamp
number
Additional properties are allowed.
#10ecTaskCommand
object
payload is depending on the task

commandID
string
_accountID
string
format: uuid
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
task name

appId
string
Default value:"ec.tasks-api"
timestamp
number
Additional properties are allowed.
#11AppServerBuildCommand
object
platform object

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
timestamp
number
Additional properties are allowed.
#12AppServerBuildEvent
object
uuid
string
format: uuid
timestamp
string
format: datetime
message
string
temporary
boolean
object
Additional properties are allowed.
buildID
string
deploymentID
string
eventType
string
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
timestamp
number
Additional properties are allowed.
#13AppServerBuildResult
object
result
string
Allowed values:
"success"
"error"
buildID
string
timestamp
string
format: datetime
content
any
result of build or error

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
timestamp
number
Additional properties are allowed.
#14ecAuthPermissionsUpdated
object
accountID
string
format: uuid
accountID whose permissions were changed

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"permissionsUpdated"
appId
string
Allowed values:
"ecAuth"
timestamp
string
format: datetime
Additional properties are allowed.
#15ecAuthTokenRevoked
object
token
string
Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
Default value:"tokenRevoked"
appId
string
Allowed values:
"ecAuth"
timestamp
string
format: datetime
Additional properties are allowed.
#16DSBEvaWebhookEvent
object
franchise
string
seoTitle

subject
string
usually booking entryID

Additional properties are allowed.
object
persistent
boolean
Default value:true
contentType
string
Default value:"application/json"
messageId
string
format: uuid
type
string
uid: eventType
currently only abo_renewed is implemented

Default value:"abo_renewed"
timestamp
string
format: datetime
Additional properties are allowed.

ec.amqp 0.10.1

Servers

Operations

SUB /{shortID}/{modelTitle}/{entryID}/{entryEventType}

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /{shortID}/_assets/{assetGroupID}/{assetID}/{assetEventType}

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /{shortID}/_auth/{accountID}/loggedIn

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /{dataManagerID}/{dataManagerEventType}

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /{dataManagerID}/{modelID}/{modelEventType}

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /{dataManagerID}/{assetGroupID}/{assetgroupEventType}

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /{dataManagerID}/account/{accountID}/deleted

Examples

This example has been generated automatically.

This example has been generated automatically.

PUB /cmd/sendMail/mailgun/{domain}

Examples

This example has been generated automatically.

This example has been generated automatically.

PUB /cmd/sendPush/hector/{appsiteID}

Examples

This example has been generated automatically.

This example has been generated automatically.

PUB /cmd/task/{task}

Examples

This example has been generated automatically.

This example has been generated automatically.

PUB /build/{platformType}/run

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /build/{platformType}/buildEvent

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /build/{platformType}/buildResult

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /ecAuth/permissionsUpdated

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /ecAuth/tokenRevoked

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /eva_webhook_events/{eventType}

Examples

This example has been generated automatically.

This example has been generated automatically.

SUB /deal/published/{dealID}

SUB /{accountID}/seen

SUB /{accountID}/{dealAction}/{dealID}

SUB /{accountID}/postedComment/{dealID}{/replyTo}{/parentComment}

SUB /{accountID}/{commentAction}/{commentID}

SUB /{accountID}/redeemedReward/{rewardID}

PUB /expo/dealbunny/ticket

Examples

This example has been generated automatically.

This example has been generated automatically.

PUB /expo/dealbunny/deleteMessageToken

Examples

This example has been generated automatically.