Shared Link Created
Triggers a flow when a shared link is created in Box.
Options
Field | Definition | Type | Required |
---|---|---|---|
Target ItemType | Choose the type of Webhook that will be applied:
|
Dropdown | TRUE |
Target Item ID | Unique ID of the item to which the Webhook will be applied. | String | TRUE |
Output
Field | Definition | Type |
---|---|---|
Event | ||
Event ID | Unique identifier of the event | String |
Event Type |
Type of event that created this file.
For example, |
String |
Event Time | Date and time when the event was triggered in Box. | Date and Time |
Webhook ID | Unique identifier of the Webhook that triggered this event. | String |
Event | Name of an event that triggered the event. | String |
Shared Link | ||
Share URL | URL that can be used to access the item on Box. | String |
Download URL | URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type. | String |
Vanity URL | Custom URL that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application. | String |
Vanity Name |
Custom vanity name to use in the Vanity URL .
|
String |
Effective Access | Effective access level for the shared link. This can be a more restrictive access level than the value in the access field when the enterprise settings restrict the allowed access levels. | String |
Effective Permission | Effective permissions for this shared link. | String |
Password Enabled? | True if the shared link requires a password to access the item; otherwise, False . |
Boolean |
Time Unshared | Date and time when this link was unshared. | Date and Time |
Download Count | Number of times this item has been downloaded. | Number |
Preview Count | Number of times this item has been previewed. | Number |
Access Level | Accessibility of the share link. | String |
Can Download? | True if the shared link allows for the item to be downloaded; otherwise, False . For shared links on folders, this also applies to any items in the folder.
|
Boolean |
Can Preview? | True if the shared link allows for the item to be previewed; otherwise, False .
For shared links on folders this also applies to any items in the folder. |
Boolean |
Shared Item ID | Unique identifier of the item for Shared Link. |
String |
Share Item Type | Type of Item for Shared Link. | String |
Created By | ||
Name | Name of user who created the Share Link. | String |
User ID | Unique identifier of the user who last created the Share Link. | String |
Email address of the user who created the Share Link. | String | |
Additional Info | ||
Additional Info | Additional information which Box can return. | Object |
Context | ||
Execution ID | Execution identifier of the Webhook event. | String |
Additional information
Note the following limitations:
-
One Webhook per item (for example, file or folder) per application per authenticated user.
-
1000 Webhooks per application per user.
-
Webhooks cannot be triggered on the root folders.
After a shared link is created, if you decide to edit the properties of the shared link, you need to use the Shared Link Updated card.