# Share events

# ShareCreatedEvent

Sent when a new share is created.

# Payload

Key Type Description
Id string A unique identifier for the share
ExternalId string The external identifier for the share

# Example

{
    "Id": "095800d2-5bca-4648-bd3d-1e95d9645aed",
    "ExternalId": "1234567"
}

# ShareDeletedEvent

Sent when a share is deleted, either through an API call or because it expired.

# Payload

Key Type Description
Id string A unique identifier for the share
ExternalId string The external identifier for the share

# Example

{
    "Id": "095800d2-5bca-4648-bd3d-1e95d9645aed",
    "ExternalId": "1234567"
}

# ShareDownloadedEvent

Sent when all recipients have downloaded all files in the share.

# Payload

Key Type Description
Id string A unique identifier for the share
ExternalId string The external identifier for the share

# Example

{
    "Id": "095800d2-5bca-4648-bd3d-1e95d9645aed",
    "ExternalId": "1234567"
}

# ShareRecipientDownloadedEvent

Sent when a recipient has downloaded all files available to them.

# Payload

Key Type Description
Id string A unique identifier for the share
ExternalId string The external identifier for the share
RecipientId string A unique identifier for the recipient
RecipientExternalId string The external identifier for the recipient
ContentIdList list of strings The identifiers of each file in the share

# Example

{
    "Id": "095800d2-5bca-4648-bd3d-1e95d9645aed",
    "ExternalId": "1234567abc",
    "RecipientId": "1fd4a05f-a593-45f9-b2a0-8ef0def5cf5d",
    "RecipientExternalId": "abcdefg123",
    "ContentIdList": [
        "cba654321",
        "cba765432",
        "cba876543",
        "cba987654"
    ]
}

# ShareRecipientsAuthenticatedEvent

Sent when a recipient authenticates successfully.

# Payload

Key Type Description
Id string A unique identifier for the share
ExternalId string The external identifier for the share
RecipientId string A unique identifier for the recipient
RecipientExternalId string The external identifier for the recipient

# Example

{
    "Id": "095800d2-5bca-4648-bd3d-1e95d9645aed",
    "ExternalId": "1234567",
    "RecipientId": "1fd4a05f-a593-45f9-b2a0-8ef0def5cf5d",
    "RecipientExternalId": "abcdefg123"
}
Last updated: 2/23/2021, 7:57:51 AM