643 matches
49 actions
ExaVault
49 actions
Storage/ExaVault
Update an existing notification. You can add additional emails or change the action or users that cause a notification to trigger.
When updating recipient emails, make sure your recipients parameter contains the full list of people who should be included on the notification. If you resend the list without an existing recipient, they will be deleted from the notification emails.
Notes:
{
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Type of action be notified about. Notifications will only be sent for the given type of action. Valid choices are **upload**, **download**, **delete** or **all** (upload/download/delete)",
"enum": [
"upload",
"download",
"delete",
"all"
]
},
"ev-access-token": {
"type": "string"
},
"ev-api-key": {
"type": "string"
},
"id": {
"type": "integer"
},
"message": {
"type": "string",
"description": "Custom message to insert into the notification emails, along with the matching activity."
},
"recipients": {
"type": "array",
"description": "Email addresses to send notification emails to. If empty, sends to the current user's email address.",
"items": {
"type": "string",
"format": "email"
}
},
"sendEmail": {
"type": "boolean",
"description": "Whether an email should be sent to the recipients when matching activity happens."
},
"usernames": {
"type": "array",
"description": "Determines which users' actions should trigger the notification. \n\nRather than listing individual users, you can also use 3 special options:\n\n- **notice\\_user\\_all** for activity by any user or share recipient\n- **notice\\_user\\_all\\_users** for activity only by user accounts\n- **notice\\_user\\_all\\_recipients** for activity only by share recipients",
"items": {
"type": "string"
}
}
},
"required": [
"ev-access-token",
"ev-api-key",
"id"
],
"additionalProperties": false
}{
"type": "object",
"description": "Response object for notifications.",
"properties": {
"data": {
"type": "object",
"description": "Object containing notification properties.",
"properties": {
"attributes": {
"type": "object",
"description": "Attributes for the notification including the path, recipients, and share data. ",
"properties": {
"action": {
"type": "string",
"description": "Action that triggers notification.",
"enum": [
"upload",
"download",
"delete",
"all"
]
},
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of notifiction creation."
},
"message": {
"type": "string",
"description": "Custom message that will be sent to the notification recipients."
},
"modified": {
"type": "string",
"format": "date-time",
"description": "Timestamp of notification modification."
},
"name": {
"type": "string",
"description": "Name of the item that the notification is set on."
},
"path": {
"type": "string",
"description": "Path to the item that the notification is set on."
},
"readableDescription": {
"type": "string",
"description": "Human readable description of the notification."
},
"readableDescriptionWithoutPath": {
"type": "string",
"description": "Human readable description of the notification without item path."
},
"recipients": {
"type": "array",
"description": "Notification recipients.",
"items": {
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of adding notification recipient."
},
"email": {
"type": "string",
"description": "Recipient email."
},
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the recipient."
},
"modified": {
"type": "string",
"format": "date-time",
"description": "Timestamp of notification recipient modification."
},
"notificationId": {
"type": "integer",
"description": "ID of the notification that the recipient belongs to."
}
}
}
},
"sendEmail": {
"type": "boolean",
"description": "Whether or not an email will send when the notification is triggered.",
"enum": [
true,
false
]
},
"shareId": {
"type": "string",
"description": "ID of the share that the notification belogns to."
},
"type": {
"type": "string",
"description": "Type of the resource the notification is attached to. ",
"enum": [
"file",
"folder",
"shared_folder",
"send_receipt",
"share_receipt",
"file_drop"
]
},
"userId": {
"type": "string",
"description": "ID of the user that the notification belongs to."
},
"usernames": {
"type": "array",
"description": "Detail on which users can trigger the notification.",
"items": {
"type": "string"
}
}
}
},
"id": {
"type": "integer",
"format": "int32"
},
"relationships": {
"type": "object",
"properties": {
"ownerUser": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
}
}
}
},
"resource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
}
}
},
"share": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string"
}
}
}
}
}
}
},
"type": {
"type": "string"
}
}
},
"included": {
"type": "array",
"items": {
"type": "object"
}
},
"responseStatus": {
"type": "integer",
"description": "Http status code of the response."
}
}
}