/
_FileUploadEvent Data Object

_FileUploadEvent Data Object

This object contains the metadata for one or more file uploads. This data is sent by the Event Notification Service to webhooks registered for file upload events.


FileUploadEvent Data Object JSONSchema
{
  "$async": true,
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "http://broker.servicepower.com/fileUploadEventDataObject.json",
  "definitions": {
    "uploadInfo": {
      "type": "object",
      "properties": {
        "FileName": {
          "description": "The normalized name of the uploaded file",
          "type": "string"
        },
        "OriginalFileName": {
          "description": "The original name of the uploaded file",
          "type": "string"
        },
        "Size": {
          "description": "Size in bytes of the uploaded file",
          "type": "string"
        },
		"MediaType": {
		  "description": "Media Type(MIME) of the uploaded file",
		  "type": "string"
		},
        "ReferenceId": {
          "description": "Reference to a workitem or other object to which the uploaded file is associated",
          "type": "string"
        },
        "RetrievalUrl": {
          "description": "The URL used to retrieve the file download URL",
          "type": "string",
          "format": "uri"
        },
        "RetrievalUrlExpiration": {
          "description": "The UTC time when the RetrievalUrl expires",
          "type": "string",
          "format": "date-time"
        },
        "UploadedOn": {
          "description": "The UTC time when the file was uploaded",
          "type": "string",
          "format": "date-time"
        },
		"Tags": {
			"description": "Event subscriber contextual metadata",
			"type": "object",
			"properties": {
				"type": "object"
			},
			"additionalProperties": true
		}
      },
      "required": [
        "FileName",
        "OriginalFileName",
        "Size",
		"MediaType",
		"ReferenceId",
        "RetrievalUrl",
        "RetrievalUrlExpiration",
        "UploadedOn",
		"Tags"
      ],
      "additionalProperties": true
    }
  },
  "properties": {
    "type": "object",
    "_Version": {
	  "description": "FileUploadEvent Data Object v1.0",
	  "const": "1.0"
    },
	"Type": {
		"enum": [
		  "10", "20", "30", "40", "50"
		]
	},
    "FileObjects": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/uploadInfo"
      }
    }
  },
  "required": [
    "_Version",
	"Type",
    "FileObjects"
  ],
  "additionalProperties": true
}
Sample FileUploadEvent Data Object
{
  "_Version": "1.0",
  "Type": "10",
  "FileObjects": [
    {
      "FileName": "xnip2022-10-19_13-13-55.jpg",
      "OriginalFileName": "XNIP2022-10-19_13-13-55.JPG",
      "RetrievalUrl": "https://app-bro-dev.s3.amazonaws.com/d3npzofuxzsulndbvuf9z4/20/sbf1221/xnip2022-10-19_13-13-55.jpg",
      "RetrievalUrlExpiration": "2022-10-20T17:30:28.000Z",
      "Size": 168216,
	  "MediaType": "image/jpeg",
      "ReferenceId": "sbf1221",
      "UploadedOn": "2022-10-19T17:30:28.000Z",
	  "Tags": {
	  	"category": "text",
		"uploadedBy": "ncha"
	  }
    }
  ]
}

Related content

Event Notification API
Event Notification API
Read with this
Event Notification Object
Event Notification Object
More like this
Webhook Request Object
Webhook Request Object
More like this
REST Other File Object APIs
REST Other File Object APIs
More like this