Fired whenever a resource is uploaded to a website via a WebDAV PUT, so automation triggers configured with a "fileUploadTrigger" can react to the new file. It is constructed and dispatched by the admin app's PutEvent listener, which resolves the website, organisation and current profile at the point of upload. It currently only supports automation triggers, not journey nodes.

Group: Journeys

Implements: TriggerEvent, FunnelEvent


Properties

PropertyReturnsDescription
attributesMap<String,Object>Extra properties attached to the event. Always empty for a file upload event.
eventIdStringThe event type identifier, always "upload", used to key automation triggers configured to react to file uploads.
leadProfileProfileThe profile associated with this event for funnel processing purposes, the same profile that performed the upload.
relatedLeadLeadThe lead related to this event, for funnel processing purposes.
sourceProfileProfileThe profile which performed the upload.
triggeredGoalsList<Class<? extends Goal>>The funnel goals triggered by this event.
triggerItem1StringThe name of the uploaded resource, used as a trigger-matching value for automations keyed on this event.
triggerItem2StringThe href of the uploaded resource's parent collection, when the resource is a common resource with a parent.
triggerItem3StringUnused for this event.
triggerItem4StringUnused for this event.
triggerItem5StringUnused for this event.
uploadedResourceThe resource that was uploaded, as resolved from the underlying PUT event.
websiteWebsiteThe website the uploaded resource belongs to, if any.

Inherited from TriggerEvent

Properties

PropertyReturnsDescription
serialisablebooleanWhether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.

Methods

isSerialisable()

Returns: boolean

Whether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.


Methods

getWebsite() · getSourceProfile() · getEventId() · getTriggerItem1() · getTriggerItem2() · getTriggerItem3() · getTriggerItem4() · getTriggerItem5() · getAttributes() · getLeadProfile() · getRelatedLead() · getUploaded() · getTriggeredGoals()

getWebsite()

Returns: Website

The website the uploaded resource belongs to, if any.

getSourceProfile()

Returns: Profile

The profile which performed the upload.

getEventId()

Returns: String

The event type identifier, always "upload", used to key automation triggers configured to react to file uploads.

getTriggerItem1()

Returns: String

The name of the uploaded resource, used as a trigger-matching value for automations keyed on this event.

getTriggerItem2()

Returns: String

The href of the uploaded resource's parent collection, when the resource is a common resource with a parent.

getTriggerItem3()

Returns: String

Unused for this event.

getTriggerItem4()

Returns: String

Unused for this event.

getTriggerItem5()

Returns: String

Unused for this event.

getAttributes()

Returns: Map<String,Object>

Extra properties attached to the event. Always empty for a file upload event.

getLeadProfile()

Returns: Profile

The profile associated with this event for funnel processing purposes, the same profile that performed the upload.

getRelatedLead()

Returns: Lead

The lead related to this event, for funnel processing purposes.

getUploaded()

Returns: Resource

The resource that was uploaded, as resolved from the underlying PUT event.

getTriggeredGoals()

Returns: List<Class<? extends Goal>>

The funnel goals triggered by this event.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.