Events: Vault

Events

The following vault events exist:

  • vault-account-create
  • vault-account-update
  • vault-account-delete
  • vault-account-credential-update
  • vault-account-user-create
  • vault-account-user-update
  • vault-account-user-delete
  • vault-account-session-create
  • vault-user-create
  • vault-user-update
  • vault-user-delete

Most events carry an object type of the same name listed below (e.g. vault-user-create carries the object VaultUserCreate). Any exceptions to this are described below.

vault-account-*

These events are triggered when a change is made to a social account within the Vault such as updating a description.

vault-account-credential-update

This is specifcially for password updates or a Facebook account type change. It carries VaultAccountUpdate objects.

vault-account-user-*

These events are triggered when a Khoros user has been granted or ungranted access to a Vault account.

vault-account-session-create

Anytime a Sprefast user logs into a Vault account, a VaultAccountEvent is emitted onto this event.

vault-user-*

These events are triggered when adding or removing a Khoros user to/from the Vault.

Objects

VaultAccountEvent

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

VaultAccountUpdate

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

change

string

Example: Requiring an access reason.

A description of the update performed.

VaultAccountUserCreate

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

accessLevel

string

The level of access the target user has on the account.

targetDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

VaultAccountUserDelete

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

targetDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

VaultAccountUserUpdate

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

change

string

Example: Requiring an access reason.

A description of the update performed.

VaultUserCreate

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

targetDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

role

string

Example: ADMINISTRATOR

The target user's role across the Vault.

VaultUserDelete

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

targetDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

VaultUserUpdate

Field

Type

Description

directoryCompanyId

number

Format: int64

The Khoros Marketing internal ID for the company.

createdDate

string

Format: date-time

actorDirectoryUserId

number

Format: int64

The ID of the user within Khoros Marketing.

change

string

Example: Requiring an access reason.

A description of the update performed.


Did this page help you?