Documentation Powered by ReDoc

Unblu Web API (5.24.2)

Download OpenAPI specification:Download

Unblu Web API v2

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

AccountSecrets

Service to read account secret of current account

getCurrentAccountSecret

getCurrentAccountSecret operation

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "$_type": "AccountSecret",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "secretKey": "string"
}

Accounts

With this service the accounts of the unblu system can be managed. Most of the provided interface needs super admin permissions. Especially if the edited account is not the one of the current user.

The Account object can be expanded. If the query parameter expand is set to contactAddressId and/or billingAddressId (e.g ?expand=contactAddressId,billingAddressId) the address id's will be automatically resolved and wrapped into the object. This can also be done when sending the object

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to create

$_type
string
Default: "Account"
Value: "Account"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

name
string

The name of the account. Maximum length of 250 characters and can not be empty.

string or Address (object)

The id to an address which is used for billing, if the contact address should not be used. Should be null, if only contact address should be used.
When creating the Account object, this property can be omitted as there are not addresses for this account anyway. If it is desired to directly define a billing address for the account while creating it, the expand feature should be used.

string or Address (object)

The id of the contact address for the account. Is also used for billing if no extra billing address is defined.
When creating the Account object, this property can be omitted as there are not addresses for this account anyway. If it is desired to directly define a contact address for the account while creating it, the expand feature should be used.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "Account",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "name": "string",
  • "billingAddress": "string",
  • "contactAddress": "string",
  • "avatar": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    },
  • "text":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "Account",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "name": "string",
  • "billingAddress": "string",
  • "contactAddress": "string",
  • "avatar": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    },
  • "text":
    {
    }
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

findByName

Returns an account by the given name or null, if there is no such account

Authorizations:
basicAuth
query Parameters
name
string

The name of the account which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getCurrentAccount

Returns the account object of the current logged in user

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "Account",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "name": "string",
  • "billingAddress": "string",
  • "contactAddress": "string",
  • "avatar": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    },
  • "text":
    {
    }
}

isAccountNameAvailable

Checks if the account name is available for the given account id

Authorizations:
basicAuth
query Parameters
name
string

The name which should be checked

accountId
string

The account id of the user for who the account should be set. When changing the name of an existing account, its id should be given. When the name is set to the one of the account, it will then also return true.

Responses

Response samples

Content type
application/json
true

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "Account",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "name": "string",
  • "billingAddress": "string",
  • "contactAddress": "string",
  • "avatar": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    },
  • "text":
    {
    }
}

update

Allows to update the current account as admin. If user is super admin, he can also update other accounts

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The account entity to update

$_type
string
Default: "Account"
Value: "Account"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

name
string

The name of the account. Maximum length of 250 characters and can not be empty.

string or Address (object)

The id to an address which is used for billing, if the contact address should not be used. Should be null, if only contact address should be used.
When creating the Account object, this property can be omitted as there are not addresses for this account anyway. If it is desired to directly define a billing address for the account while creating it, the expand feature should be used.

string or Address (object)

The id of the contact address for the account. Is also used for billing if no extra billing address is defined.
When creating the Account object, this property can be omitted as there are not addresses for this account anyway. If it is desired to directly define a contact address for the account while creating it, the expand feature should be used.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "Account",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "name": "string",
  • "billingAddress": "string",
  • "contactAddress": "string",
  • "avatar": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    },
  • "text":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "Account",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "name": "string",
  • "billingAddress": "string",
  • "contactAddress": "string",
  • "avatar": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    },
  • "text":
    {
    }
}

Addresses

With this service, the addresses of accounts can be managed.

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to create

$_type
string
Default: "Address"
Value: "Address"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

organisationName
string

Name of the organisation. Maximum of 250 characters. Can be omitted.

addressLine1
string

First address line. Maximum of 250 characters. Can be omitted.

addressLine2
string

Second address line. Maximum of 250 characters. Can be omitted.

zip
string

Zip code of the city. Maximum of 20 characters. Can not be omitted.

city
string

City name. Maximum of 250 characters. Can not be omitted.

state
string

Country state. Maximum of 250 characters. Can be omitted.

country
string

Country. Maximum of 250 characters. Can not be omitted.

Responses

Request samples

Content type
application/json
{
  • "$_type": "Address",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "organisationName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "Address",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "organisationName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "Address",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "organisationName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to update

$_type
string
Default: "Address"
Value: "Address"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

organisationName
string

Name of the organisation. Maximum of 250 characters. Can be omitted.

addressLine1
string

First address line. Maximum of 250 characters. Can be omitted.

addressLine2
string

Second address line. Maximum of 250 characters. Can be omitted.

zip
string

Zip code of the city. Maximum of 20 characters. Can not be omitted.

city
string

City name. Maximum of 250 characters. Can not be omitted.

state
string

Country state. Maximum of 250 characters. Can be omitted.

country
string

Country. Maximum of 250 characters. Can not be omitted.

Responses

Request samples

Content type
application/json
{
  • "$_type": "Address",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "organisationName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "Address",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "organisationName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

ApiKeys

With this service the api keys can be managed

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to create

$_type
string
Default: "ApiKey"
Value: "ApiKey"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

apiKey
string

Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server). Can not be updated.

name
string

Name of the api key. Maximum of 250 characters. Can be omitted, but should not.

description
string

Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getByKey

Returns the api key object for the given api key string in the current account

Authorizations:
basicAuth
query Parameters
apiKey
string

The api key for which the object should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

getDefaultForAccountId

Returns the default api key for the given account id. If the id of the account does not match with the one from the current user, null is returned

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

getQuotaUsage

Returns the number of entities already existing (for the current account)

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
0

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to update

$_type
string
Default: "ApiKey"
Value: "ApiKey"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

apiKey
string

Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server). Can not be updated.

name
string

Name of the api key. Maximum of 250 characters. Can be omitted, but should not.

description
string

Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Authenticator

Service to log in with a user or to switch to other accounts/users by impersonating them

authenticateWithToken

Authentication using a previously created authentication token from (createAuthenticationToken). Will create an authentication session if authentication succeeds (includes setting an authentication cookie)

Authorizations:
basicAuth
query Parameters
authenticationToken
string

token to login with

redirectOnSuccess
string

redirection URL when the operation is successful

redirectOnFailure
string

redirection URL when the operation is not successful

Responses

Response samples

Content type
application/json
true

changePassword

Changes password for currently logged in user, if the old password is currently matching the stored password

Authorizations:
basicAuth
Request Body schema: application/json
oldPassword
string

The old password for validation

newPassword
string

The new password to set

Responses

Request samples

Content type
application/json

Change password

{
  • "oldPassword": "L0remPf18!",
  • "newPassword": "L1rem_Hq23"
}

Response samples

Content type
application/json
true

checkPasswordAgainstPolicy

checks if a 'potential' password is valid given the current password policy

Authorizations:
basicAuth
Request Body schema: application/json
password
string

Password to check against policy

Responses

Request samples

Content type
application/json

Check if the password will be accepted or not

{
  • "password": "L0remPf18!"
}

Response samples

Content type
application/json
[
  • "string"
]

checkSuperAdminPasswordFile

checks if a password file for the superadmin exists

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
true

createAuthenticationToken

Creates a new authentication token, which can later be used for login.

Authorizations:
basicAuth
Request Body schema: application/json
username
string

The username for which the token is created

password
string

The password of the user to authenticate

Responses

Request samples

Content type
application/json

Create a token for a given username and password

{
  • "username": "r@email.com",
  • "password": "L0remPf18!"
}

Response samples

Content type
application/json
"string"

createAuthenticationTokenForCurrentUser

Creates a new authentication token for the current logged in user.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
"string"

getAuthenticatedUserDisplayName

Returns the name of the user which can be displayed somewhere

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
"string"

getAuthenticatedUserName

Returns the name of the logged in user

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
"string"

getCompactUser

Returns a compact user object, which contains the most important information about the current logged in user.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "CompactUser",
  • "id": "string",
  • "accountId": "string",
  • "username": "string",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "avatar": "string",
  • "teamId": "string",
  • "parentTeamIds":
    [
    ],
  • "permissions":
    {
    },
  • "authorizationRole": "SUPER_ADMIN",
  • "passwordDefined": true,
  • "virtual": true,
  • "propagated": true,
  • "impersonatedFromUserId": "string",
  • "impersonatedFromAccountId": "string"
}

getUserId

The user id of the current user

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
"string"

getUserPermissions

Returns the permissions of the current user

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "$_type": "Permissions",
  • "allPermissions": true,
  • "permissions":
    [
    ]
}

getUserRole

Returns the user role of the current logged in user

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
"string"

impersonate

Impersonates with another user either via username or userid (one of the two may be null).

Authorizations:
basicAuth
Request Body schema: application/json
username
string

If set and userid is set to null, the user is searched by the name

userId
string

If set, the username is ignored and the user for the given id is impersonated

superUser
boolean

if true, the impersonated user will have the SUPER_ADMIN role (even if he hasn't normally).

redirectOnSuccess
string

redirection URL when the operation is successful

redirectOnFailure
string

redirection URL when the operation is not successful

Responses

Request samples

Content type
application/json

Impersonate as user 'admin' without keeping the superadmin rights

{
  • "username": "admin",
  • "userId": null,
  • "superUser": false,
  • "redirectOnSuccess": null,
  • "redirectOnFailure": null
}

Response samples

Content type
application/json
true

isAuthenticated

Checks if the current client is authenticated and session has not expired

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
true

isRegisteredUser

Checks if the user is a registered user and not a web user or anonymous one from the system

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
true

isSuperAdmin

Checks if the current user is super admin

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
true

login

Login using username and password credentials. Will create an authentication session if login succeeds (includes setting an authentication cookie)

Authorizations:
basicAuth
Request Body schema: application/json
username
string

user to use for login

password
string

password to use for login

redirectOnSuccess
string

redirection URL when the operation is successful

redirectOnFailure
string

redirection URL when the operation is not successful

Responses

Request samples

Content type
application/json

Login with username and password

{
  • "username": "r@email.com",
  • "password": "L0remPf18!",
  • "redirectOnSuccess": null,
  • "redirectOnFailure": null
}

Response samples

Content type
application/json
true

logout

Call this to logout (clear internal session and session cookie on response)

Authorizations:
basicAuth
Request Body schema: application/json
redirectOnSuccess
string

redirection URL when the operation is successful

Responses

Request samples

Content type
application/json

Logout with a redirection to unblu.com

{}

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

resetImpersonation

Resets the current impersonation. Will do nothing if there is no impersonation.

Authorizations:
basicAuth
Request Body schema: application/json
redirectOnSuccess
string

redirection URL when the operation is successful. Also if nothing needed to be done.

redirectOnFailure
string

redirection URL when the operation is not successful

Responses

Request samples

Content type
application/json

Reset impersonation and redirect to the Global Configuration page on success

{
  • "redirectOnSuccess": "/co-unblu/config-global",
  • "redirectOnFailure": null
}

Response samples

Content type
application/json
true

sendPasswordResetMail

Sends a reset password link to the user by email only if the user exists

Authorizations:
basicAuth
Request Body schema: application/json
username
string

The username of the user which receives a password reset mail

Responses

Request samples

Content type
application/json

Reset impersonation and redirect to the Global Configuration page on success

{
  • "username": "r@email.com"
}

Response samples

Content type
application/json
true

setDefaultLanguage

Changes the language of the current user. It is stored also in the returned cookies
Note: A reload should be done afterwards.

Authorizations:
basicAuth
Request Body schema: application/json
language
string

The new language-tag (as defined in the IETF BCP 47) for the language which should be used (e.g. en - english, de - german, fr - french, it - italian)

Responses

Request samples

Content type
application/json

Change the default language to french

{
  • "language": "fr"
}

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

setNewPassword

Saves a new password for the user behind the given authentication token. The token can be created withcreateAuthenticationToken. The user needs to be authenticated first.

Authorizations:
basicAuth
Request Body schema: application/json
authenticationToken
string

for authentication.

password
string

the new password to be used

Responses

Request samples

Content type
application/json

Set a new password

{
  • "authenticationToken": "Y2w5el...naW77w=",
  • "password": "L0remPf18!"
}

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

switchToAccount

Switches the account in a given authentication session. If successful, the user is treated, as if he/she was a member of the target account.

Authorizations:
basicAuth
Request Body schema: application/json
accountId
string

the account id to impersonate on

redirectOnSuccess
string

redirection URL when the operation is successful

redirectOnFailure
string

redirection URL when the operation is not successful

Responses

Request samples

Content type
application/json

Switch to account with a redirect to the Account Configuration page on success

{
  • "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
  • "redirectOnSuccess": "/co-unblu/config-account",
  • "redirectOnFailure": null
}

Response samples

Content type
application/json
true

Avatars

With this service, the avatar pictures can be managed.

create

Creates the avatar in the system. The id can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to create

$_type
string
Default: "Avatar"
Value: "Avatar"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefor can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

imageZoomFactor
number <float>

Zoom factor to crop the original image. Must be bigger than 1. If omitted a minimal factor will be computed.

imageXPositionRatio
number <float>

Ratio to determine the horizontal position of the cropping area. Must be between 0 and 1: 0 means moved at the left border, 1 means moved at the right border. If omitted 0.5 will be used.

imageYPositionRatio
number <float>

Ratio to determine the vertical position of the cropping area. Must be between 0 and 1: 0 means moved at the top border, 1 means moved at the bottom border. If omitted 0.5 will be used.

imageRotationAngle
integer <int32>

Clockwise angle in degree (0-380) for rotation. If omitted 0 will be used.

imageData
string

Image content as data URL scheme (RFC2397 - data:[<mediatype>][;base64],<data>)

Responses

Request samples

Content type
application/json
{
  • "$_type": "Avatar",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "accountId": "string",
  • "imageZoomFactor": 0,
  • "imageXPositionRatio": 0,
  • "imageYPositionRatio": 0,
  • "imageRotationAngle": 0,
  • "imageData": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "Avatar",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "accountId": "string",
  • "imageZoomFactor": 0,
  • "imageXPositionRatio": 0,
  • "imageYPositionRatio": 0,
  • "imageRotationAngle": 0,
  • "imageData": "string"
}

read

Returns the avatar for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "Avatar",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "accountId": "string",
  • "imageZoomFactor": 0,
  • "imageXPositionRatio": 0,
  • "imageYPositionRatio": 0,
  • "imageRotationAngle": 0,
  • "imageData": "string"
}

CannedResponses

Service to manage canned responses.
The canned responses a user can edit and the once he can use for chat can differ. The once he can edit are depending on his role. The ones he can use in a chat depends on the team setup and his role. See the following policies for the list of chat messages available for chat:

  • All canned responses of the own user.
  • All canned responses of the team cascade (the users team and all of the parent teams)
  • All canned responses of the sub-teams if role is: SUPERVISOR or higher.
  • All canned responses of all teams if role is: ADMIN or higher.
  • All canned responses of the users account.
In comparison to this the creation/editing/deleting of canned responses follow the following policies:
  • All canned responses of the own user.
  • All canned responses of the sub-teams if role is: SUPERVISOR or higher.
  • All canned responses of all teams if role is: ADMIN or higher.
  • All canned responses of the users account if role is: ADMIN or higher.

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to create

$_type
string
Default: "CannedResponse"
Value: "CannedResponse"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

ownerId
string

Id of the owner of the entity. Can not be omitted.

ownerType
string (EPropertyOwnerType)
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

key
string

The key of a canned response to access it quickly. Maximum of 250 characters. Can not be omitted.

title
string

The title of a canned response. Maximum of 250 characters. Can be omitted, but should not.

text
string

The text of a canned response. Can be omitted, but should not.

Responses

Request samples

Content type
application/json
Example
create for account
create for account
create for team
create for user

Create a new canned response for the account

{
  • "$_type": "CannedResponse",
  • "id": null,
  • "dateCreated": null,
  • "dateModified": null,
  • "version": null,
  • "accountId": null,
  • "ownerId": null,
  • "ownerType": "ACCOUNT",
  • "key": "niceDay",
  • "title": "Have a nice day",
  • "text": "It was great chatting with you, have a nice day!"
}

Response samples

Content type
application/json
Example
create for account
create for account
create for team
create for user

New canned response for the account

{
  • "$_type": "CannedResponse",
  • "id": "EasFde6CRn83pnBCec_4Ds0",
  • "dateCreated": 1546300800000,
  • "dateModified": 1548979200000,
  • "version": 1,
  • "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
  • "ownerId": "A7d9E_0-c3cC4aoFDb85t6n",
  • "ownerType": "ACCOUNT",
  • "key": "niceDay",
  • "title": "Have a nice day",
  • "text": "It was great chatting with you, have a nice day!"
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

findByKey

Returns a list of canned response for the given key

Authorizations:
basicAuth
query Parameters
key
string

The key of the canned response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

findByTeamId

Returns a list of canned responses for the given team

Authorizations:
basicAuth
query Parameters
teamId
string

The id of the team for which all canned responses should be returned

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAll

Returns a list of all canned responses for the current account

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of canned responses for the given id's

Authorizations:
basicAuth
Request Body schema: application/json

The id's for which the canned responses should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getByOwnerTypeAndId

Return's a list of entities for an owner type and owner id. See EPropertyOwnerType

Authorizations:
basicAuth
query Parameters
ownerType
string

to search for

ownerId
string

to search for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getCannedResponsesAvailableForChat

Returns all CannedResponses that are available inside chat sessions for the calling user.
The user may be allowed to edit more than the returned canned responses if he has the rights.

Note: For editing use the getByOwnerTypeAndId or getAll service.


Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getWritableConfigurationScopes

Returns a list of all configuration scopes for which the calling user may add, delete or edits canned responses. Depending on the permissions of the users, these configuration scopes can be more then the ones which are available for the user in a chat.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getWritableConfigurationScopesAvailableForChat

Returns all configurations scopes available for chat to the calling user that the calling user may add, delete and edit canned responses for.

Note: The returned scopes may be equal to or be a subset of the the scopes returned by getWritableConfigurationScopes depending on the user role.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

read

Returns the canned response for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the canned response which should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "CannedResponse",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "key": "string",
  • "title": "string",
  • "text": "string"
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to update

$_type
string
Default: "CannedResponse"
Value: "CannedResponse"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

ownerId
string

Id of the owner of the entity. Can not be omitted.

ownerType
string (EPropertyOwnerType)
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

key
string

The key of a canned response to access it quickly. Maximum of 250 characters. Can not be omitted.

title
string

The title of a canned response. Maximum of 250 characters. Can be omitted, but should not.

text
string

The text of a canned response. Can be omitted, but should not.

Responses

Request samples

Content type
application/json
{
  • "$_type": "CannedResponse",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "key": "string",
  • "title": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "CannedResponse",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "key": "string",
  • "title": "string",
  • "text": "string"
}

Contacts

Service to access the contact data for an account

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to create

$_type
string
Default: "Contact"
Value: "Contact"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

ownerId
string

Id of the owner of the entity. Can not be omitted.

ownerType
string (EPropertyOwnerType)
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

type
string (EContactType)
Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL"

Type of a contact information

data
string

The data of the contact information. e.g. a phone number. It is used for presentation. Can not be omitted.

rawData
string

The raw data of the contact information. In most cases it is the same as the data field. Can not be omitted.

Responses

Request samples

Content type
application/json
{
  • "$_type": "Contact",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "type": "UNKNOWN_PHONE",
  • "data": "string",
  • "rawData": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "Contact",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "type": "UNKNOWN_PHONE",
  • "data": "string",
  • "rawData": "string"
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

findByContactType

Returns a list of contact information for the given type

Authorizations:
basicAuth
query Parameters
contactType
string (EContactType)
Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL"

The type for which the contact information should be retrieved

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "Contact",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "type": "UNKNOWN_PHONE",
  • "data": "string",
  • "rawData": "string"
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to update

$_type
string
Default: "Contact"
Value: "Contact"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

ownerId
string

Id of the owner of the entity. Can not be omitted.

ownerType
string (EPropertyOwnerType)
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

type
string (EContactType)
Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL"

Type of a contact information

data
string

The data of the contact information. e.g. a phone number. It is used for presentation. Can not be omitted.

rawData
string

The raw data of the contact information. In most cases it is the same as the data field. Can not be omitted.

Responses

Request samples

Content type
application/json
{
  • "$_type": "Contact",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "type": "UNKNOWN_PHONE",
  • "data": "string",
  • "rawData": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "Contact",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "type": "UNKNOWN_PHONE",
  • "data": "string",
  • "rawData": "string"
}

ConversationHistory

Service to access conversation details

findAllBy

Returns the conversation history data of all conversations matching certain criteria. This will return all conversations matching the given search criteria.

startTimestamp and endTimestamp meaning: All conversations with an overlapping duration (start till end) will be returned.

Authorizations:
basicAuth
query Parameters
startTimestamp
integer <int64>

(mandatory parameter) utc timestamp defining the beginning of the search period. Conversation must be ended after the startTimestamp or not ended.

endTimestamp
integer <int64>

(mandatory parameter) utc timestamp defining the end of the search period. Conversation must be created before the endTimestamp.

initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

search only for conversations having a specific engagement type

conversationState
string (EConversationState)
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

search only for conversations having a specific state

limit
integer <int32>

limit the number of items in the result list

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getMessageLog

Gets the list of messages belonging to a specific conversation

Authorizations:
basicAuth
query Parameters
conversationId
string

id of the conversation

Responses

Response samples

Content type
application/json
[
  • {
    }
]

read

Returns the conversation history data for a given conversation.

Authorizations:
basicAuth
query Parameters
conversationId
string

id of the conversation

Responses

Response samples

Content type
application/json
{
  • "$_type": "ConversationHistoryData",
  • "id": "string",
  • "recipient":
    {
    },
  • "assigneePerson":
    {
    },
  • "contextPerson":
    {
    },
  • "endPerson":
    {
    },
  • "participants":
    [
    ],
  • "createdTimestamp": 0,
  • "onboardingTimestamp": 0,
  • "assigneeJoinTimestamp": 0,
  • "activationTimestamp": 0,
  • "offboardingTimestamp": 0,
  • "endTimestamp": 0,
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "endReason": "ENDED_BY_PARTICIPANT",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string"
}

ConversationTemplates

Service to manage all conversation templates.

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to create

$_type
string
Default: "ConversationTemplate"
Value: "ConversationTemplate"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

name
string

Name of the named area. Maximum of 250 characters. Can not be omitted.

description
string

Description of the named area. Maximum of 500 characters. Can be omitted.

defaultTemplate
boolean

If true, this will be the default template for the initial engagement Type

initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "ConversationTemplate",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultTemplate": true,
  • "initialEngagementType": "CHAT_REQUEST",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationTemplate",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultTemplate": true,
  • "initialEngagementType": "CHAT_REQUEST",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getDefaultTemplateByEngagementType

Gets the default conversation template for a given initial engagement type

Authorizations:
basicAuth
query Parameters
initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "ConversationTemplate",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultTemplate": true,
  • "initialEngagementType": "CHAT_REQUEST",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "ConversationTemplate",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultTemplate": true,
  • "initialEngagementType": "CHAT_REQUEST",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to update

$_type
string
Default: "ConversationTemplate"
Value: "ConversationTemplate"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

name
string

Name of the named area. Maximum of 250 characters. Can not be omitted.

description
string

Description of the named area. Maximum of 500 characters. Can be omitted.

defaultTemplate
boolean

If true, this will be the default template for the initial engagement Type

initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "ConversationTemplate",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultTemplate": true,
  • "initialEngagementType": "CHAT_REQUEST",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationTemplate",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultTemplate": true,
  • "initialEngagementType": "CHAT_REQUEST",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Conversations

Service to manage conversations

addParticipant

Add a participant to a conversation.

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
personId
string

Responses

Request samples

Content type
application/json

Add a participant to a conversation

{
  • "personId": "nta30CBa-6d1a89cE57Db_F"
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

configure

Update the configuration map for a specific conversation

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

the key-value map of configuration

property name*
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

configureText

Update the text map for a specific conversation

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

the key-value map of texts

object

Responses

Request samples

Content type
application/json
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

create

Creates the conversation in the system. The id of the conversation must not be set for the 'create' operation as a new one will be generated.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
$_type
string
Default: "ConversationData"
Value: "ConversationData"
id
string

Unique id of the conversation. When creating an entity this property can be omitted as it will be generated by the server anyway.

accountId
string

Account id to which the conversation belongs to. When creating a conversation, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

topic
string

Topic of the conversation. Can be omitted.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

Array of objects (ParticipantData)

Current participants of the conversation

assigneePersonId
string

PersonId of the assignee, must be one of the participants

contextPersonId
string

PersonId of the main visitor, must be one of the participants

state
string (EConversationState)
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

Life cycle state of the conversation

initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

tokboxSessionId
string

Tokbox sessionId. When creating a conversation this property can be omitted as it will be generated by the server anyway.

conversationTemplateId
string

Template id of this conversation. If omitted, the default conversationTemplate will be retrieved based on the initialEngagementType

Array of objects (ConversationLink)

Links to open the conversation. When creating a conversation this property can be omitted as it will be generated by the server anyway.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

Response samples

Content type
application/json

New conversation created

{
  • "$_type": "ConversationData",
  • "id": "AcviDb210C5BoFd6e_79oan",
  • "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
  • "topic": null,
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": null,
  • "contextPersonId": "nta30CBa-6d1a89cE57Db_F",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": null,
  • "conversationTemplateId": "ab32em6Be-5le_48rE1F9Ad",
  • "links":
    [
    ],
  • "configuration": null,
  • "text": null
}

delete

Deletes the conversation for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the conversation which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

end

End a conversation.

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
reason
string (EConversationEndReason)
Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "OTHER"

Closing reason of a conversation

comment
string

Responses

Request samples

Content type
application/json

End a conversation

{
  • "reason": "OTHER",
  • "comment": "Some comment"
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

findByParticipant

Returns a list of all conversations where a person is involved as participant.

Authorizations:
basicAuth
query Parameters
personId
string

the id of the person

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAll

Returns a list of all conversations for the current user

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

read

Returns the conversation for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the conversation which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

removeParticipant

Offboard a participant from a conversation.

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
personId
string
reason
string (EConversationLeftReason)
Enum: "FORWARDED" "PARTICIPANT_LEFT" "REMOVED_AFTER_TIMEOUT" "ONBOARDING_DECLINED" "USER_CHANGED" "KICKED" "OTHER"

Participation left reason of a conversation

comment
string

Responses

Request samples

Content type
application/json

Remove a participant

{
  • "personId": "nta30CBa-6d1a89cE57Db_F",
  • "reason": "OTHER",
  • "comment": "Some other important reason"
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

setAssigneePerson

Set an agent as assignee to a conversation.

Note: The person has to have an active participation in the conversation

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
personId
string

Responses

Request samples

Content type
application/json

Set the assigned agent

{
  • "personId": "nta30CBa-6d1a89cE57Db_F"
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

setContextPerson

Set a visitor as context person of a conversation.

Note: The person has to have an active participation in the conversation

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
personId
string

Responses

Request samples

Content type
application/json

Set the primary visitor

{
  • "personId": "nta30CBa-6d1a89cE57Db_F"
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

setRecipient

Set a person, named area, team or account as the recipient of a conversation.

Authorizations:
basicAuth
path Parameters
conversationId
required
string

the conversation that is updated

query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
$_type
string
Default: "AccountData"
AccountData
AccountData
NamedAreaData
PersonData
TeamData
id
string

Unique id of the account.

displayName
string

Display-Name of the account

string or Avatar (object)

Avatar of the account: id that can be expanded.

Responses

Request samples

Content type
application/json
Example
AccountData
AccountData
NamedAreaData
PersonData
TeamData
{
  • "$_type": "AccountData",
  • "id": "string",
  • "displayName": "string",
  • "avatar": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}

Domains

Service to manage the domains of the account. A domain needs to be defined to use unblu on it.

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to create

$_type
string
Default: "Domain"
Value: "Domain"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

domainName
string

The name/adress of the domain. It should normally contain a protocol (e.g. http:// or https://) and the url of the domain (e.g. www.unblu.com). Maximum of 250 characters. Can not be omitted. 250 characters.

Responses

Request samples

Content type
application/json
{
  • "$_type": "Domain",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "domainName": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "Domain",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "domainName": "string"
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

getAccountDomainsAsString

Returns all configured domains for the current account as strings

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • "string"
]

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getQuotaUsage

Returns the number of entities already existing (for the current account)

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
0

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "Domain",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "domainName": "string"
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to update

$_type
string
Default: "Domain"
Value: "Domain"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

domainName
string

The name/adress of the domain. It should normally contain a protocol (e.g. http:// or https://) and the url of the domain (e.g. www.unblu.com). Maximum of 250 characters. Can not be omitted. 250 characters.

Responses

Request samples

Content type
application/json
{
  • "$_type": "Domain",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "domainName": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "Domain",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "domainName": "string"
}

Global

With this service the global Unblu system can be managed.

For super-admin the Global object can be expanded to set configuration or translations.

installLicense

Install a new license in the global server.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: text/plain

licenseContent

string

Responses

Response samples

Content type
application/json
{
  • "$_type": "GlobalData",
  • "serverIdentifier": "string",
  • "currentLicense":
    {
    },
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

productVersion

productVersion operation

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "$_type": "ProductVersion",
  • "productVersion": "string",
  • "productGuid": "string"
}

read

Returns the GlobalData object containing information about the system (license, settings).

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "GlobalData",
  • "serverIdentifier": "string",
  • "currentLicense":
    {
    },
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

update

Updates the GlobalData object. Since the properties of the Global object are read-only, this methods only make sense when used with the expand parameter.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
$_type
string
Default: "GlobalData"
Value: "GlobalData"
serverIdentifier
string

A unique id identifying an Unblu installation. This is read only information it will be set by the server anyway.

object (LicenseData)

Entity representing the current installed license

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "GlobalData",
  • "serverIdentifier": "string",
  • "currentLicense":
    {
    },
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "GlobalData",
  • "serverIdentifier": "string",
  • "currentLicense":
    {
    },
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

NamedAreas

Service to manage named areas.

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to create

$_type
string
Default: "NamedArea"
Value: "NamedArea"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

name
string

Name of the named area. Maximum of 250 characters. Can not be omitted.

description
string

Description of the named area. Maximum of 500 characters. Can be omitted.

type
string (ENamedAreaType)
Enum: "META_TAG" "DOMAIN"

Type of a named area

siteId
string

Meta tag name if the type is META_TAG or domain name if the type is DOMAIN. If the type is META_TAG, it can be omitted during creation and a random ID will generated for it. Modification of this attribute is not allowed. Maximum of 250 characters.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "NamedArea",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "description": "string",
  • "type": "META_TAG",
  • "siteId": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "NamedArea",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "description": "string",
  • "type": "META_TAG",
  • "siteId": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

getAll

Returns a list of all named areas for the current account

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of named areas for the given id's

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The id's for which the named areas should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getQuotaUsage

Returns the number of entities already existing (for the current account)

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
0

read

Returns the named area for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the named area which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "NamedArea",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "description": "string",
  • "type": "META_TAG",
  • "siteId": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to update

$_type
string
Default: "NamedArea"
Value: "NamedArea"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

name
string

Name of the named area. Maximum of 250 characters. Can not be omitted.

description
string

Description of the named area. Maximum of 500 characters. Can be omitted.

type
string (ENamedAreaType)
Enum: "META_TAG" "DOMAIN"

Type of a named area

siteId
string

Meta tag name if the type is META_TAG or domain name if the type is DOMAIN. If the type is META_TAG, it can be omitted during creation and a random ID will generated for it. Modification of this attribute is not allowed. Maximum of 250 characters.

object
object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "NamedArea",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "description": "string",
  • "type": "META_TAG",
  • "siteId": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "NamedArea",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "description": "string",
  • "type": "META_TAG",
  • "siteId": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}

Persons

Service to manage persons

createOrUpdateBot

Updates and returns an existing bot person or creates and returns a bot person if absent.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

person data

$_type
string
Default: "PersonData"
Value: "PersonData"
id
string

Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway.

accountId
string

Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

personSource
string (EPersonSource)
Enum: "USER_DB" "VIRTUAL"

The source type of a person (participant of a conversation)

sourceId
string

Identifier of the person in its source (defined by personSource). For EPersonSource.USER_DB this is the userId, forEPersonSource.VIRTUAL the propagated user id.

sourceData
string

Vendor specific data.

firstName
string

The first name of the person. Maximum length of 250 characters. Can be omitted.

lastName
string

the last name of the person. Maximum length of 250 characters. Can be omitted.

username
string

The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted.

nickname
string

A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted.

displayName
string

Display name of the person. This is read only information, it will be set by the server anyway.

personType
string (EPersonType)
Enum: "AGENT" "VISITOR" "SYSTEM" "BOT"

The type of a person (participant of a session)

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

email
string

The email of the person. Optional.

phone
string

The phone of the person. Optional.

teamId
string

Team id of the person. Optional.

teamName
string

Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

Responses

Request samples

Content type
application/json
{
  • "$_type": "PersonData",
  • "id": null,
  • "accountId": null,
  • "personSource": null,
  • "sourceId": "bot3",
  • "sourceData": null,
  • "firstName": null,
  • "lastName": null,
  • "username": "Example BOT3",
  • "nickname": null,
  • "displayName": null,
  • "personType": null,
  • "authorizationRole": null,
  • "email": "bot3@example.com",
  • "phone": null,
  • "teamId": null,
  • "teamName": null,
  • "avatar": null
}

Response samples

Content type
application/json
{
  • "$_type": "PersonData",
  • "id": "nta30CBa-6d1a89cE57Db_F",
  • "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
  • "personSource": "VIRTUAL",
  • "sourceId": "bot3",
  • "sourceData": null,
  • "firstName": null,
  • "lastName": null,
  • "username": "Example BOT3",
  • "nickname": null,
  • "displayName": "Bot",
  • "personType": "BOT",
  • "authorizationRole": "REGISTERED_USER",
  • "email": "bot3@example.com",
  • "phone": null,
  • "teamId": null,
  • "teamName": "",
  • "avatar": null
}

createOrUpdateVirtual

Updates and returns an existing virtual person or creates and returns a virtual person if absent.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

person data

$_type
string
Default: "PersonData"
Value: "PersonData"
id
string

Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway.

accountId
string

Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

personSource
string (EPersonSource)
Enum: "USER_DB" "VIRTUAL"

The source type of a person (participant of a conversation)

sourceId
string

Identifier of the person in its source (defined by personSource). For EPersonSource.USER_DB this is the userId, forEPersonSource.VIRTUAL the propagated user id.

sourceData
string

Vendor specific data.

firstName
string

The first name of the person. Maximum length of 250 characters. Can be omitted.

lastName
string

the last name of the person. Maximum length of 250 characters. Can be omitted.

username
string

The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted.

nickname
string

A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted.

displayName
string

Display name of the person. This is read only information, it will be set by the server anyway.

personType
string (EPersonType)
Enum: "AGENT" "VISITOR" "SYSTEM" "BOT"

The type of a person (participant of a session)

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

email
string

The email of the person. Optional.

phone
string

The phone of the person. Optional.

teamId
string

Team id of the person. Optional.

teamName
string

Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

Responses

Request samples

Content type
application/json
{
  • "$_type": "PersonData",
  • "id": "string",
  • "accountId": "string",
  • "personSource": "USER_DB",
  • "sourceId": "string",
  • "sourceData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "displayName": "string",
  • "personType": "AGENT",
  • "authorizationRole": "SUPER_ADMIN",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "teamName": "string",
  • "avatar": "string"
}

Response samples

Content type
application/json
{
  • "$_type": "PersonData",
  • "id": "string",
  • "accountId": "string",
  • "personSource": "USER_DB",
  • "sourceId": "string",
  • "sourceData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "displayName": "string",
  • "personType": "AGENT",
  • "authorizationRole": "SUPER_ADMIN",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "teamName": "string",
  • "avatar": "string"
}

findBySource

Find a person by source

Authorizations:
basicAuth
query Parameters
personSource
string (EPersonSource)
Enum: "USER_DB" "VIRTUAL"

Source of the of the person

sourceId
string

Identifier of the person in its source

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "PersonData",
  • "id": "string",
  • "accountId": "string",
  • "personSource": "USER_DB",
  • "sourceId": "string",
  • "sourceData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "displayName": "string",
  • "personType": "AGENT",
  • "authorizationRole": "SUPER_ADMIN",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "teamName": "string",
  • "avatar": "string"
}

getAllAgents

Returns all persons of type AGENT

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

read

Helper method read a PersonData by id

Authorizations:
basicAuth
query Parameters
id
string
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "PersonData",
  • "id": "string",
  • "accountId": "string",
  • "personSource": "USER_DB",
  • "sourceId": "string",
  • "sourceData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "displayName": "string",
  • "personType": "AGENT",
  • "authorizationRole": "SUPER_ADMIN",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "teamName": "string",
  • "avatar": "string"
}

Services

Service which provides metadata information for all services and used types.

getAllServiceNames

Returns the name of all available services

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • "string"
]

getAllServices

Returns a list of all available services

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAllServicesMetadata

Returns all metadata information available in one batch

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "$_type": "ServicesContainer",
  • "version": "string",
  • "services":
    [
    ],
  • "webhookEvents":
    [
    ],
  • "types":
    [
    ]
}

getAllTypeNames

Returns A list of all type names used by the services and the webhook events

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • "string"
]

getAllTypes

Returns All available types used by the services and the webhook events

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAllWebhookEventTypeNames

Returns all webhook event type names

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • "string"
]

getAllWebhookEventTypes

Returns all webhook event types

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getServiceByName

Returns the metadata for the requested service

Authorizations:
basicAuth
path Parameters
serviceName
required
string

The name of the service of which the metadata should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "WebApiService",
  • "documentation": "string",
  • "name": "string",
  • "implementationName": "string",
  • "resources":
    [
    ]
}

getTypeByName

Returns a type definition by the given name

Authorizations:
basicAuth
path Parameters
name
required
string

The name of the type of which the metadata should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "ServiceType",
  • "documentation": "string",
  • "name": "string",
  • "implementationName": "string",
  • "isEnum": true,
  • "additionalExpandables":
    [
    ],
  • "properties":
    [
    ],
  • "staticProperties":
    [
    ],
  • "implementationTypes":
    [
    ]
}

getWebhookEventTypeByName

Returns the webhook event type definition for the requested webhook event

Authorizations:
basicAuth
path Parameters
name
required
string

The name of the webhook event type of which the metadata should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "ServiceWebhookEventType",
  • "documentation": "string",
  • "name": "string",
  • "implementationName": "string",
  • "properties":
    [
    ],
  • "staticProperties":
    [
    ]
}

Teams

Service to manage all teams in the system. For each account there is always a default team, which users are assigned to, when no explicit team is set.

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to create

$_type
string
Default: "Team"
Value: "Team"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

name
string

Name of the team. Maximum of 250 characters. Can not be omitted.

parentId
string

Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server.

description
string

Description of the team. Maximum of 500 characters. Can be omitted.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "Team",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "Team",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

getAll

Returns a list of all teams for the current account

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of teams for the given id's

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The id's for which the teams should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getByParentId

Returns a list of teams, which directly belong to the given parent team.

Authorizations:
basicAuth
query Parameters
parentId
string

The id of the parent for which the direct child teams should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getChildTeamIds

Returns a list of teams ids, which recursively belong to the given parent team. So child teams of a child team are also listed

Authorizations:
basicAuth
query Parameters
teamId
string

The ID of the parent team for which the child teams should be returned recursively

Responses

Response samples

Content type
application/json
[
  • "string"
]

getChildTeams

Returns a list of teams, which recursively belong to the given parent team. So child teams of a child team are also listed

Authorizations:
basicAuth
query Parameters
teamId
string

The ID of the parent team for which the child teams should be returned recursively

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getQuotaUsage

Returns the number of entities already existing (for the current account)

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
0

getTeamOfCurrentUser

Returns the team of the current logged in user. There is always a team, at least the default team.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "Team",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

read

Returns the team for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the team which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "Team",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

teamIsChildOfOtherTeam

Checks if the subTeamId is a child team of the parentTeamId.
If isParentTeamItselfAllowed is true, this functions returns true if subTeamId is equals parentTeamId.
This check is recursive. It will check all parent teams of the sub team until it either finds the given parent team or if there is no parent team anymore.

Authorizations:
basicAuth
query Parameters
parentTeamId
string

The parent team id against which the check should be done

subTeamId
string

The sub team id, which is checked against the parent team id

Responses

Response samples

Content type
application/json
true

update

Updates the team entity with the given instance. A supervisor can change his team and all sub teams

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to update

$_type
string
Default: "Team"
Value: "Team"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

name
string

Name of the team. Maximum of 250 characters. Can not be omitted.

parentId
string

Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server.

description
string

Description of the team. Maximum of 500 characters. Can be omitted.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "Team",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "Team",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Users

Service to manage all users in the system.

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The entity to create

$_type
string
Default: "User"
Value: "User"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

username
string

The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address.

email
string

The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used.

phone
string

The phone number of the user. Maximum length of 100 characters.

teamId
string

The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account.

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

displayName
string

The display name of the user. Will be calculated by the server. Can be omitted while creating a user.

firstName
string

The first name of the user. Maximum length of 250 characters. Can not be omitted.

lastName
string

the last name of the user. Maximum length of 250 characters. Can not be omitted.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

createUserWithRandomPassword

Creates a new user with a random password. The random password is returned and also send via email, if email is correctly configured.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The user data with which the new user is created

$_type
string
Default: "User"
Value: "User"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

username
string

The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address.

email
string

The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used.

phone
string

The phone number of the user. Maximum length of 100 characters.

teamId
string

The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account.

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

displayName
string

The display name of the user. Will be calculated by the server. Can be omitted while creating a user.

firstName
string

The first name of the user. Maximum length of 250 characters. Can not be omitted.

lastName
string

the last name of the user. Maximum length of 250 characters. Can not be omitted.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "UserPasswordContainer",
  • "user":
    {
    },
  • "password": "string"
}

createWithPassword

Creates a new user with the provided password for login.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The user and the password which should be created

$_type
string
Default: "UserPasswordContainer"
Value: "UserPasswordContainer"
object (User)

Model of a user. A user is normally an agent and/or a person who manages the system

password
string

The password which belongs to the user

Responses

Request samples

Content type
application/json

create a new user with a given password

{
  • "$_type": "UserPasswordContainer",
  • "user":
    {
    },
  • "password": "L0remPf18!"
}

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

doesUserLoginExist

Checks if the given username exists in the system. Only checks the current account.

Authorizations:
basicAuth
query Parameters
username
string

The username which will be looked up

Responses

Response samples

Content type
application/json
true

findByTeamId

Returns the direct members of the given team

Authorizations:
basicAuth
query Parameters
teamId
string

The id of the team of the requested users

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

findByUsername

Returns the user for the given username.

Authorizations:
basicAuth
query Parameters
username
string

The username of the requested user

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

getAll

Returns a list of all users for the current account

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of users for the given id's

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The id's for which the users should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getQuotaUsage

Returns the number of entities already existing (for the current account)

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
0

isSuperUser

Checks if the given user id belongs to a super admin user.

Authorizations:
basicAuth
query Parameters
userId
string

The id of a user which should be checked

Responses

Response samples

Content type
application/json
true

isUsernameAvailable

Checks if the username is available in general or for the given userId. Checks all accounts.

Authorizations:
basicAuth
query Parameters
name
string

The name which should be checked

userId
string

The user id of the user for who the username should be set. When set, the name of the user (for himself) is considered as available.

Responses

Response samples

Content type
application/json
true

read

Returns the user for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the user which should be returned

expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"

Responses

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

update

Updates the given user with the new data.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The new user data

$_type
string
Default: "User"
Value: "User"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

username
string

The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address.

email
string

The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used.

phone
string

The phone number of the user. Maximum length of 100 characters.

teamId
string

The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account.

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

displayName
string

The display name of the user. Will be calculated by the server. Can be omitted while creating a user.

firstName
string

The first name of the user. Maximum length of 250 characters. Can not be omitted.

lastName
string

the last name of the user. Maximum length of 250 characters. Can not be omitted.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

updateAndRemovePassword

Updates a user and remove the existing password of this user. Without password the user will not be able to log in directly into the system. Users without a password are typically used in setups with ID propagation.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The user which should be updated (password will be removed)

$_type
string
Default: "User"
Value: "User"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

username
string

The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address.

email
string

The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used.

phone
string

The phone number of the user. Maximum length of 100 characters.

teamId
string

The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account.

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

displayName
string

The display name of the user. Will be calculated by the server. Can be omitted while creating a user.

firstName
string

The first name of the user. Maximum length of 250 characters. Can not be omitted.

lastName
string

the last name of the user. Maximum length of 250 characters. Can not be omitted.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

updatePassword

Updates the password of the given user.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json
userId
string

The id of the user which should be updated

password
string

The new password for the user

Responses

Request samples

Content type
application/json

update password for a given user

{
  • "userId": "d5_2rD019scCA7eEB48U6ab",
  • "password": "L0remPf18!"
}

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

updateUserWithRandomPassword

Updates the password of a user with a new random password and also the user data. The random password is returned and also send via email, if email is correctly configured.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The user which should be updated with a random password

$_type
string
Default: "User"
Value: "User"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

username
string

The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address.

email
string

The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used.

phone
string

The phone number of the user. Maximum length of 100 characters.

teamId
string

The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account.

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

displayName
string

The display name of the user. Will be calculated by the server. Can be omitted while creating a user.

firstName
string

The first name of the user. Maximum length of 250 characters. Can not be omitted.

lastName
string

the last name of the user. Maximum length of 250 characters. Can not be omitted.

object
object

Responses

Request samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "$_type": "UserPasswordContainer",
  • "user":
    {
    },
  • "password": "string"
}

updateWithPassword

Updates the password of the given user.

Authorizations:
basicAuth
query Parameters
expand
Array of strings (ExpandFields)
Items Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
Request Body schema: application/json

The user and the password which should be updated

$_type
string
Default: "UserPasswordContainer"
Value: "UserPasswordContainer"
object (User)

Model of a user. A user is normally an agent and/or a person who manages the system

password
string

The password which belongs to the user

Responses

Request samples

Content type
application/json

update user and password

{
  • "$_type": "UserPasswordContainer",
  • "user":
    {
    },
  • "password": "L0remPf18!"
}

Response samples

Content type
application/json
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}

userHasPassword

Checks if a user has a password defined.

Authorizations:
basicAuth
query Parameters
userId
string

The id of the user to check

Responses

Response samples

Content type
application/json
true

WebhookCallLogs

Service to get logs of webhook calls

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

getCallLogForWebhookRegistration

Returns a list of webhook calls for the given registration id. The registration id is returned, when registering a webhook

Authorizations:
basicAuth
path Parameters
registrationId
required
string

The id of the webhook registration for which the call log should be returned

Responses

Response samples

Content type
application/json
[
  • {
    }
]

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "WebhookCallLog",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "registrationId": "string",
  • "requestId": "string",
  • "executionTimestamp": 0,
  • "endpoint": "string",
  • "retryNr": 0,
  • "callId": "string",
  • "eventName": "string",
  • "requestHeaders": "string",
  • "requestSent": "string",
  • "requestSentTableColumn": "string",
  • "requestFileStoreId": "string",
  • "httpResponseCode": 0,
  • "httpResponseReason": "string",
  • "httpResponseHeaders": "string",
  • "responseFromServer": "string",
  • "responseFromServerTableColumn": "string",
  • "responseFileStoreId": "string"
}

WebhookRegistrations

Service to manage all webhook registrations

create

Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to create

$_type
string
Default: "WebhookRegistration"
Value: "WebhookRegistration"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

name
string

Name of the webhook registration. Maximum length of 250 characters. Can not be omitted.

status
string (ERegistrationStatus)
Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE"

Possible Webhook Registration Status

description
string

Description of the webhook registration. Maximum length of 500 characters. Can be omitted.

endpoint
string

The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can be omitted, but should not.

secret
string

A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted.

events
Array of strings

Events for which the webhook endpoint is called, if they occur. Can not be omitted. Check the Webhook Events for possible values.

Responses

Callbacks

postaccount
postagent_forwarding.created
postagent_forwarding.redeemed
postagent_forwarding.revoked
postagent_invitation.created
postagent_invitation.redeemed
postagent_invitation.revoked
postapi_key
postassignment_request.created
postassignment_request.redeemed
postassignment_request.revoked
postconversation.created
postconversation.ended
postconversation.updated
postdomain
postnamed_area
postperson
postpin.created
postpin.redeemed
postpin.renewed
postpin.revoked
postping
postteam
postuser
postvisitor_invitation.created
postvisitor_invitation.redeemed
postvisitor_invitation.renewed
postvisitor_invitation.revoked

Request samples

Content type
application/json
{
  • "$_type": "WebhookRegistration",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "status": "ACTIVE",
  • "description": "string",
  • "endpoint": "string",
  • "secret": "string",
  • "events":
    [
    ]
}

Response samples

Content type
application/json
{
  • "$_type": "WebhookRegistration",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "status": "ACTIVE",
  • "description": "string",
  • "endpoint": "string",
  • "secret": "string",
  • "events":
    [
    ]
}

Callback payload samples

Callback
POST: account
POST: account
POST: agent_forwarding.created
POST: agent_forwarding.redeemed
POST: agent_forwarding.revoked
POST: agent_invitation.created
POST: agent_invitation.redeemed
POST: agent_invitation.revoked
POST: api_key
POST: assignment_request.created
POST: assignment_request.redeemed
POST: assignment_request.revoked
POST: conversation.created
POST: conversation.ended
POST: conversation.updated
POST: domain
POST: named_area
POST: person
POST: pin.created
POST: pin.redeemed
POST: pin.renewed
POST: pin.revoked
POST: ping
POST: team
POST: user
POST: visitor_invitation.created
POST: visitor_invitation.redeemed
POST: visitor_invitation.renewed
POST: visitor_invitation.revoked
Content type
application/json
{
  • "$_type": "AccountModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

delete

Deletes the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

The id of the entity which should be deleted

Responses

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

getAll

Returns a list of all entities for the current account

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByEventName

Returns all registrations for the event name.

Authorizations:
basicAuth
query Parameters
eventName
string

Event name to check.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getByIds

Gets a list of entities for the given id's

Authorizations:
basicAuth
Request Body schema: application/json

The id's for which the entities should be fetched

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

ping

Sends a "ping" webhook to the endpoint of the given registration.

Authorizations:
basicAuth
Request Body schema: application/json
id
string

Id of the registration to send the ping webhook to.

Responses

Request samples

Content type
application/json

Send a ping event for the given Webhook registration

{
  • "id": "r1acbAidia_35-tB4o7FbWR"
}

Response samples

Content type
application/json
{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}

read

Returns the entity for the given id

Authorizations:
basicAuth
query Parameters
id
string

Id of the entity which should be returned

Responses

Response samples

Content type
application/json
{
  • "$_type": "WebhookRegistration",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "status": "ACTIVE",
  • "description": "string",
  • "endpoint": "string",
  • "secret": "string",
  • "events":
    [
    ]
}

update

Updates the entity in the system with the given entity.

Authorizations:
basicAuth
Request Body schema: application/json

The entity to update

$_type
string
Default: "WebhookRegistration"
Value: "WebhookRegistration"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

name
string

Name of the webhook registration. Maximum length of 250 characters. Can not be omitted.

status
string (ERegistrationStatus)
Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE"

Possible Webhook Registration Status

description
string

Description of the webhook registration. Maximum length of 500 characters. Can be omitted.

endpoint
string

The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can be omitted, but should not.

secret
string

A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted.

events
Array of strings

Events for which the webhook endpoint is called, if they occur. Can not be omitted. Check the Webhook Events for possible values.

Responses

Request samples

Content type
application/json
{
  • "$_type": "WebhookRegistration",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "status": "ACTIVE",
  • "description": "string",
  • "endpoint": "string",
  • "secret": "string",
  • "events":
    [
    ]
}

Response samples

Content type
application/json
{
  • "$_type": "WebhookRegistration",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "status": "ACTIVE",
  • "description": "string",
  • "endpoint": "string",
  • "secret": "string",
  • "events":
    [
    ]
}

For Webhooks

account

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AccountModificationEvent"
Value: "AccountModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (Account)

Model of an account. The contact and the billing address can be directly resolved when using the expand feature.

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "AccountModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

agent_forwarding.created

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AgentForwardingCreatedEvent"
Value: "AgentForwardingCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

Array of objects (ConversationLink)

List of links that can be used to accept the accept forwarding event with the token.
Only one link can be used.

{
  • "$_type": "AgentForwardingCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "links":
    [
    ]
}

agent_forwarding.redeemed

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AgentForwardingRedeemedEvent"
Value: "AgentForwardingRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "AgentForwardingRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "redeemingPerson":
    {
    }
}

agent_forwarding.revoked

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AgentForwardingRevokedEvent"
Value: "AgentForwardingRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

{
  • "$_type": "AgentForwardingRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string"
}

agent_invitation.created

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AgentInvitationCreatedEvent"
Value: "AgentInvitationCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

Array of objects (ConversationLink)

List of links that can be used to accept the agent invitation event with the token.
Only one link can be used.

{
  • "$_type": "AgentInvitationCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "links":
    [
    ]
}

agent_invitation.redeemed

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AgentInvitationRedeemedEvent"
Value: "AgentInvitationRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "AgentInvitationRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "redeemingPerson":
    {
    }
}

agent_invitation.revoked

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AgentInvitationRevokedEvent"
Value: "AgentInvitationRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

{
  • "$_type": "AgentInvitationRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string"
}

api_key

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "ApiKeyModificationEvent"
Value: "ApiKeyModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (ApiKey)

Model of an ApiKey. Api keys identify the usage of unblu to a certain account. There can be multiple api keys per account to define different configurations

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "ApiKeyModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

assignment_request.created

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AssignmentRequestCreatedEvent"
Value: "AssignmentRequestCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

Array of objects (ConversationLink)

List of links that can be used to accept the assignment request event with the token.
Only one link can be used.

{
  • "$_type": "AssignmentRequestCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "links":
    [
    ]
}

assignment_request.redeemed

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AssignmentRequestRedeemedEvent"
Value: "AssignmentRequestRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "AssignmentRequestRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "redeemingPerson":
    {
    }
}

assignment_request.revoked

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "AssignmentRequestRevokedEvent"
Value: "AssignmentRequestRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

{
  • "$_type": "AssignmentRequestRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    }
}

conversation.created

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "ConversationCreatedEvent"
Value: "ConversationCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (ConversationData)

Metadata information about a conversation

{
  • "$_type": "ConversationCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "conversation":
    {
    }
}

conversation.ended

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "ConversationEndedEvent"
Value: "ConversationEndedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (ConversationData)

Metadata information about a conversation

{
  • "$_type": "ConversationEndedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "conversation":
    {
    }
}

conversation.updated

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "ConversationUpdatedEvent"
Value: "ConversationUpdatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (ConversationData)

Metadata information about a conversation

{
  • "$_type": "ConversationUpdatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "conversation":
    {
    }
}

domain

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "DomainModificationEvent"
Value: "DomainModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (Domain)

Model of a domain

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "DomainModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

named_area

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "NamedAreaModificationEvent"
Value: "NamedAreaModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (NamedArea)

Model of named areas. They can either be domains or meta tags

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "NamedAreaModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

person

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "PersonModificationEvent"
Value: "PersonModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (PersonData)

Representation of a Person (Agent or Visitor)

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "PersonModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

pin.created

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "PinCreatedEvent"
Value: "PinCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the pin event with the token.
Only one link can be used.

{
  • "$_type": "PinCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}

pin.redeemed

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "PinRedeemedEvent"
Value: "PinRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "PinRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0,
  • "redeemingPerson":
    {
    }
}

pin.renewed

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "PinRenewedEvent"
Value: "PinRenewedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the visitor invitation event with the token.
Only one link can be used.

{
  • "$_type": "PinRenewedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}

pin.revoked

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "PinRevokedEvent"
Value: "PinRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

{
  • "$_type": "PinRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0
}

ping

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "WebhookPingEvent"
Value: "WebhookPingEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (WebhookRegistration)

Model of a webhook registration. Registered webhooks for certain events are stored inside this model.

{
  • "$_type": "WebhookPingEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "webhookConfiguration":
    {
    }
}

team

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "TeamModificationEvent"
Value: "TeamModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (Team)

Model of a team. A team consist out of multiple users. For each account there is at least the default team.

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "TeamModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

user

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "UserModificationEvent"
Value: "UserModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (User)

Model of a user. A user is normally an agent and/or a person who manages the system

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "UserModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}

visitor_invitation.created

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "VisitorInvitationCreatedEvent"
Value: "VisitorInvitationCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the visitor invitation event with the token.
Only one link can be used.

{
  • "$_type": "VisitorInvitationCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}

visitor_invitation.redeemed

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "VisitorInvitationRedeemedEvent"
Value: "VisitorInvitationRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "VisitorInvitationRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0,
  • "redeemingPerson":
    {
    }
}

visitor_invitation.renewed

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "VisitorInvitationRenewedEvent"
Value: "VisitorInvitationRenewedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the visitor invitation event with the token.
Only one link can be used.

{
  • "$_type": "VisitorInvitationRenewedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}

visitor_invitation.revoked

Following request-body is send as POST request on the URL used to register the callback:

$_type
string
Default: "VisitorInvitationRevokedEvent"
Value: "VisitorInvitationRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

{
  • "$_type": "VisitorInvitationRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0
}
$_type
string
Default: "Account"
Value: "Account"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

name
string

The name of the account. Maximum length of 250 characters and can not be empty.

string or Address (object)

The id to an address which is used for billing, if the contact address should not be used. Should be null, if only contact address should be used.
When creating the Account object, this property can be omitted as there are not addresses for this account anyway. If it is desired to directly define a billing address for the account while creating it, the expand feature should be used.

string or Address (object)

The id of the contact address for the account. Is also used for billing if no extra billing address is defined.
When creating the Account object, this property can be omitted as there are not addresses for this account anyway. If it is desired to directly define a contact address for the account while creating it, the expand feature should be used.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

object
object
object
{
  • "$_type": "Account",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "name": "string",
  • "billingAddress": "string",
  • "contactAddress": "string",
  • "avatar": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    },
  • "text":
    {
    }
}
$_type
string
Default: "AccountData"
Value: "AccountData"
id
string

Unique id of the account.

displayName
string

Display-Name of the account

string or Avatar (object)

Avatar of the account: id that can be expanded.

{
  • "$_type": "AccountData",
  • "id": "string",
  • "displayName": "string",
  • "avatar": "string"
}
$_type
string
Default: "AccountModificationEvent"
Value: "AccountModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (Account)

Model of an account. The contact and the billing address can be directly resolved when using the expand feature.

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "AccountModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}
$_type
string
Default: "AccountSecret"
Value: "AccountSecret"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

secretKey
string
{
  • "$_type": "AccountSecret",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "secretKey": "string"
}
$_type
string
Default: "Address"
Value: "Address"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

organisationName
string

Name of the organisation. Maximum of 250 characters. Can be omitted.

addressLine1
string

First address line. Maximum of 250 characters. Can be omitted.

addressLine2
string

Second address line. Maximum of 250 characters. Can be omitted.

zip
string

Zip code of the city. Maximum of 20 characters. Can not be omitted.

city
string

City name. Maximum of 250 characters. Can not be omitted.

state
string

Country state. Maximum of 250 characters. Can be omitted.

country
string

Country. Maximum of 250 characters. Can not be omitted.

{
  • "$_type": "Address",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "organisationName": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}
$_type
string
Default: "AgentForwardingCreatedEvent"
Value: "AgentForwardingCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

Array of objects (ConversationLink)

List of links that can be used to accept the accept forwarding event with the token.
Only one link can be used.

{
  • "$_type": "AgentForwardingCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "links":
    [
    ]
}
$_type
string
Default: "AgentForwardingRedeemedEvent"
Value: "AgentForwardingRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "AgentForwardingRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "redeemingPerson":
    {
    }
}
$_type
string
Default: "AgentForwardingRevokedEvent"
Value: "AgentForwardingRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

{
  • "$_type": "AgentForwardingRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string"
}
$_type
string
Default: "AgentInvitationCreatedEvent"
Value: "AgentInvitationCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

Array of objects (ConversationLink)

List of links that can be used to accept the agent invitation event with the token.
Only one link can be used.

{
  • "$_type": "AgentInvitationCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "links":
    [
    ]
}
$_type
string
Default: "AgentInvitationRedeemedEvent"
Value: "AgentInvitationRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "AgentInvitationRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string",
  • "redeemingPerson":
    {
    }
}
$_type
string
Default: "AgentInvitationRevokedEvent"
Value: "AgentInvitationRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (AgentTargetData)

Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as PersonData) or a team (as TeamData). In this second case multiple agents are targeted by the event.

comment
string

Text provided by the creator for the target

{
  • "$_type": "AgentInvitationRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "comment": "string"
}
$_type
string
Default: "PersonData"
PersonData
PersonData
TeamData
id
string

Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway.

accountId
string

Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

personSource
string (EPersonSource)
Enum: "USER_DB" "VIRTUAL"

The source type of a person (participant of a conversation)

sourceId
string

Identifier of the person in its source (defined by personSource). For EPersonSource.USER_DB this is the userId, forEPersonSource.VIRTUAL the propagated user id.

sourceData
string

Vendor specific data.

firstName
string

The first name of the person. Maximum length of 250 characters. Can be omitted.

lastName
string

the last name of the person. Maximum length of 250 characters. Can be omitted.

username
string

The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted.

nickname
string

A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted.

displayName
string

Display name of the person. This is read only information, it will be set by the server anyway.

personType
string (EPersonType)
Enum: "AGENT" "VISITOR" "SYSTEM" "BOT"

The type of a person (participant of a session)

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

email
string

The email of the person. Optional.

phone
string

The phone of the person. Optional.

teamId
string

Team id of the person. Optional.

teamName
string

Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

Example
PersonData
PersonData
TeamData
{
  • "$_type": "PersonData",
  • "id": "string",
  • "accountId": "string",
  • "personSource": "USER_DB",
  • "sourceId": "string",
  • "sourceData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "displayName": "string",
  • "personType": "AGENT",
  • "authorizationRole": "SUPER_ADMIN",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "teamName": "string",
  • "avatar": "string"
}
$_type
string
Default: "ApiKey"
Value: "ApiKey"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

apiKey
string

Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server). Can not be updated.

name
string

Name of the api key. Maximum of 250 characters. Can be omitted, but should not.

description
string

Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted.

object
object
object
{
  • "$_type": "ApiKey",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "apiKey": "string",
  • "name": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}
$_type
string
Default: "ApiKeyModificationEvent"
Value: "ApiKeyModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (ApiKey)

Model of an ApiKey. Api keys identify the usage of unblu to a certain account. There can be multiple api keys per account to define different configurations

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "ApiKeyModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}
$_type
string
Default: "ArrayBody"
Value: "ArrayBody"
Array of objects (BodyElement)
{
  • "$_type": "ArrayBody",
  • "elements":
    [
    ]
}
$_type
string
Default: "AssignmentRequestCreatedEvent"
Value: "AssignmentRequestCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

Array of objects (ConversationLink)

List of links that can be used to accept the assignment request event with the token.
Only one link can be used.

{
  • "$_type": "AssignmentRequestCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "links":
    [
    ]
}
$_type
string
Default: "AssignmentRequestRedeemedEvent"
Value: "AssignmentRequestRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "AssignmentRequestRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    },
  • "redeemingPerson":
    {
    }
}
$_type
string
Default: "AssignmentRequestRevokedEvent"
Value: "AssignmentRequestRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

object (ContextPersonInfo)

Information about the context person of a conversation. Normally send together with webhook events.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

{
  • "$_type": "AssignmentRequestRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "contextPersonInfo":
    {
    },
  • "target":
    {
    }
}
oldPassword
string

The old password for validation

newPassword
string

The new password to set

{
  • "oldPassword": "string",
  • "newPassword": "string"
}
password
string

Password to check against policy

{
  • "password": "string"
}
username
string

The username for which the token is created

password
string

The password of the user to authenticate

{
  • "username": "string",
  • "password": "string"
}
username
string

If set and userid is set to null, the user is searched by the name

userId
string

If set, the username is ignored and the user for the given id is impersonated

superUser
boolean

if true, the impersonated user will have the SUPER_ADMIN role (even if he hasn't normally).

redirectOnSuccess
string

redirection URL when the operation is successful

redirectOnFailure
string

redirection URL when the operation is not successful

{
  • "username": "string",
  • "userId": "string",
  • "superUser": true,
  • "redirectOnSuccess": "string",
  • "redirectOnFailure": "string"
}
username
string

user to use for login

password
string

password to use for login

redirectOnSuccess
string

redirection URL when the operation is successful

redirectOnFailure
string

redirection URL when the operation is not successful

{
  • "username": "string",
  • "password": "string",
  • "redirectOnSuccess": "string",
  • "redirectOnFailure": "string"
}
redirectOnSuccess
string

redirection URL when the operation is successful

{
  • "redirectOnSuccess": "string"
}
redirectOnSuccess
string

redirection URL when the operation is successful. Also if nothing needed to be done.

redirectOnFailure
string

redirection URL when the operation is not successful

{
  • "redirectOnSuccess": "string",
  • "redirectOnFailure": "string"
}
username
string

The username of the user which receives a password reset mail

{
  • "username": "string"
}
language
string

The new language-tag (as defined in the IETF BCP 47) for the language which should be used (e.g. en - english, de - german, fr - french, it - italian)

{
  • "language": "string"
}
authenticationToken
string

for authentication.

password
string

the new password to be used

{
  • "authenticationToken": "string",
  • "password": "string"
}
accountId
string

the account id to impersonate on

redirectOnSuccess
string

redirection URL when the operation is successful

redirectOnFailure
string

redirection URL when the operation is not successful

{
  • "accountId": "string",
  • "redirectOnSuccess": "string",
  • "redirectOnFailure": "string"
}
$_type
string
Default: "Avatar"
Value: "Avatar"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefor can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

imageZoomFactor
number <float>

Zoom factor to crop the original image. Must be bigger than 1. If omitted a minimal factor will be computed.

imageXPositionRatio
number <float>

Ratio to determine the horizontal position of the cropping area. Must be between 0 and 1: 0 means moved at the left border, 1 means moved at the right border. If omitted 0.5 will be used.

imageYPositionRatio
number <float>

Ratio to determine the vertical position of the cropping area. Must be between 0 and 1: 0 means moved at the top border, 1 means moved at the bottom border. If omitted 0.5 will be used.

imageRotationAngle
integer <int32>

Clockwise angle in degree (0-380) for rotation. If omitted 0 will be used.

imageData
string

Image content as data URL scheme (RFC2397 - data:[<mediatype>][;base64],<data>)

{
  • "$_type": "Avatar",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "accountId": "string",
  • "imageZoomFactor": 0,
  • "imageXPositionRatio": 0,
  • "imageYPositionRatio": 0,
  • "imageRotationAngle": 0,
  • "imageData": "string"
}
$_type
string
Default: "BodyElement"
Value: "BodyElement"
typeName
string

Name of the type

isArray
boolean

True if the type is an array

numArrayDim
integer <int32>

0 if type is not an array. Otherwise the property defines the number of dimension of the property. E.g. with 2 a string type would be a 2 dim string array: string[][]

isEnum
boolean

True if the type is an enum

Array of objects (ServiceTypeBinding)

Type arguments for generic types. E.g. a list has generic types: list<string> generic type would be string

name
string
documentation
string
{
  • "$_type": "BodyElement",
  • "typeName": "string",
  • "isArray": true,
  • "numArrayDim": 0,
  • "isEnum": true,
  • "typeArgs":
    [
    ],
  • "name": "string",
  • "documentation": "string"
}
$_type
string
Default: "CannedResponse"
Value: "CannedResponse"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

ownerId
string

Id of the owner of the entity. Can not be omitted.

ownerType
string (EPropertyOwnerType)
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

key
string

The key of a canned response to access it quickly. Maximum of 250 characters. Can not be omitted.

title
string

The title of a canned response. Maximum of 250 characters. Can be omitted, but should not.

text
string

The text of a canned response. Can be omitted, but should not.

{
  • "$_type": "CannedResponse",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "key": "string",
  • "title": "string",
  • "text": "string"
}
$_type
string
Default: "CannedResponseConfigurationScope"
Value: "CannedResponseConfigurationScope"
name
string

Name of the scope

ownerId
string

Id of the owner. It defines to whom the configuration is assigned

ownerType
string (EPropertyOwnerType)
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

{
  • "$_type": "CannedResponseConfigurationScope",
  • "name": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL"
}
$_type
string
Default: "CompactUser"
Value: "CompactUser"
id
string

Id of the user

accountId
string

Account id of the user

username
string

username for login

displayName
string

Displayed name of the user

firstName
string

First name of the user

lastName
string

Last name of the user

string or Avatar (object)

Avatar of the user: id that can be expanded.

teamId
string

id of the team the user belongs to

parentTeamIds
Array of strings

Ids of the parent teams. That are recursively the parent team of each parent team

object (Permissions)

Container for permissions of a user

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

passwordDefined
boolean

True if the user has a password defined

virtual
boolean

True if the user is virtual (does not exist in the database);

propagated
boolean

True if the user is propagated (did not log in locally but identity was propagateds);

impersonatedFromUserId
string

id of the user from which the impersonation was initiated. Null if no impersonation is used.

impersonatedFromAccountId
string

id of the account from which the impersonation was initiated. Null if no impersonation is used.

{
  • "$_type": "CompactUser",
  • "id": "string",
  • "accountId": "string",
  • "username": "string",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "avatar": "string",
  • "teamId": "string",
  • "parentTeamIds":
    [
    ],
  • "permissions":
    {
    },
  • "authorizationRole": "SUPER_ADMIN",
  • "passwordDefined": true,
  • "virtual": true,
  • "propagated": true,
  • "impersonatedFromUserId": "string",
  • "impersonatedFromAccountId": "string"
}
$_type
string
Default: "Contact"
Value: "Contact"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

ownerId
string

Id of the owner of the entity. Can not be omitted.

ownerType
string (EPropertyOwnerType)
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

type
string (EContactType)
Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL"

Type of a contact information

data
string

The data of the contact information. e.g. a phone number. It is used for presentation. Can not be omitted.

rawData
string

The raw data of the contact information. In most cases it is the same as the data field. Can not be omitted.

{
  • "$_type": "Contact",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "ownerId": "string",
  • "ownerType": "GLOBAL",
  • "type": "UNKNOWN_PHONE",
  • "data": "string",
  • "rawData": "string"
}
$_type
string
Default: "ContextPersonInfo"
Value: "ContextPersonInfo"
id
string

Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway.

accountId
string

Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

personSource
string (EPersonSource)
Enum: "USER_DB" "VIRTUAL"

The source type of a person (participant of a conversation)

sourceId
string

Identifier of the person in its source (defined by personSource). For EPersonSource.USER_DB this is the userId, forEPersonSource.VIRTUAL the propagated user id.

sourceData
string

Vendor specific data.

firstName
string

The first name of the person. Maximum length of 250 characters. Can be omitted.

lastName
string

the last name of the person. Maximum length of 250 characters. Can be omitted.

username
string

The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted.

nickname
string

A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted.

displayName
string

Display name of the person. This is read only information, it will be set by the server anyway.

personType
string (EPersonType)
Enum: "AGENT" "VISITOR" "SYSTEM" "BOT"

The type of a person (participant of a session)

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

email
string

The email of the person. Optional.

phone
string

The phone of the person. Optional.

teamId
string

Team id of the person. Optional.

teamName
string

Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

osName
string

The operation system name of the visitors computer

osVersion
string

The version of the operation system of the visitors computer

browserName
string

The name of the browser the visitor uses

browserVersion
string

The version of the browser the visitor uses

localeLanguage
string

The language defined in the browser of the visitor

localeCountry
string

The country language of the browser if the visitor

city
string

The city in which the visitor is (probably)

country
string

The country in which the visitor is (probable)

{
  • "$_type": "ContextPersonInfo",
  • "id": "string",
  • "accountId": "string",
  • "personSource": "USER_DB",
  • "sourceId": "string",
  • "sourceData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "displayName": "string",
  • "personType": "AGENT",
  • "authorizationRole": "SUPER_ADMIN",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "teamName": "string",
  • "avatar": "string",
  • "osName": "string",
  • "osVersion": "string",
  • "browserName": "string",
  • "browserVersion": "string",
  • "localeLanguage": "string",
  • "localeCountry": "string",
  • "city": "string",
  • "country": "string"
}
$_type
string
Default: "ConversationCreatedEvent"
Value: "ConversationCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (ConversationData)

Metadata information about a conversation

{
  • "$_type": "ConversationCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "conversation":
    {
    }
}
$_type
string
Default: "ConversationData"
Value: "ConversationData"
id
string

Unique id of the conversation. When creating an entity this property can be omitted as it will be generated by the server anyway.

accountId
string

Account id to which the conversation belongs to. When creating a conversation, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

topic
string

Topic of the conversation. Can be omitted.

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

Array of objects (ParticipantData)

Current participants of the conversation

assigneePersonId
string

PersonId of the assignee, must be one of the participants

contextPersonId
string

PersonId of the main visitor, must be one of the participants

state
string (EConversationState)
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

Life cycle state of the conversation

initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

tokboxSessionId
string

Tokbox sessionId. When creating a conversation this property can be omitted as it will be generated by the server anyway.

conversationTemplateId
string

Template id of this conversation. If omitted, the default conversationTemplate will be retrieved based on the initialEngagementType

Array of objects (ConversationLink)

Links to open the conversation. When creating a conversation this property can be omitted as it will be generated by the server anyway.

object
object
{
  • "$_type": "ConversationData",
  • "id": "string",
  • "accountId": "string",
  • "topic": "string",
  • "recipient":
    {
    },
  • "participants":
    [
    ],
  • "assigneePersonId": "string",
  • "contextPersonId": "string",
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string",
  • "links":
    [
    ],
  • "configuration":
    {
    },
  • "text":
    {
    }
}
$_type
string
Default: "ConversationEndedEvent"
Value: "ConversationEndedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (ConversationData)

Metadata information about a conversation

{
  • "$_type": "ConversationEndedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "conversation":
    {
    }
}
$_type
string
Default: "ConversationHistoryData"
Value: "ConversationHistoryData"
id
string

Id of the conversation

any (ConversationRecipientData)

Recipient of a conversation: Either a single PersonData, TeamData, NamedAreaData or AccountData. For compatibility reasons,RecipientData is also supported.

object (PersonData)

Representation of a Person (Agent or Visitor)

object (PersonData)

Representation of a Person (Agent or Visitor)

object (PersonData)

Representation of a Person (Agent or Visitor)

Array of objects (ParticipantHistoryData)

All participants (present and past) of the conversation

createdTimestamp
integer <int64>

utc timestamp when the conversation was created (timestamp when the state was set to EConversationState.CREATED)

onboardingTimestamp
integer <int64>

utc timestamp when the onboarding of the conversation started (timestamp when the state was set to EConversationState.ONBOARDING)

assigneeJoinTimestamp
integer <int64>

utc timestamp when the assignee joined the conversation (timestamp when the state of the first agent participant was set toEConversationParticipationState.ACTIVE) Value is null of no assignee has joined yet.

activationTimestamp
integer <int64>

utc timestamp when the conversation was activated (timestamp when the state was set to EConversationState.ACTIVE)

offboardingTimestamp
integer <int64>

utc timestamp when the offboarding of the conversation started (timestamp when the state was set to EConversationState.OFFBOARDING)

endTimestamp
integer <int64>

utc timestamp when the conversation has ended (all active participants have finished their offboarding; timestamp when the state was set toEConversationState.ENDED)

state
string (EConversationState)
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

Life cycle state of the conversation

initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

endReason
string (EConversationEndReason)
Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "OTHER"

Closing reason of a conversation

tokboxSessionId
string

Tokbox sessionId.

conversationTemplateId
string

Template id of this conversation. If omitted, the default conversationTemplate will be retrieved based on the initialEngagementType

{
  • "$_type": "ConversationHistoryData",
  • "id": "string",
  • "recipient":
    {
    },
  • "assigneePerson":
    {
    },
  • "contextPerson":
    {
    },
  • "endPerson":
    {
    },
  • "participants":
    [
    ],
  • "createdTimestamp": 0,
  • "onboardingTimestamp": 0,
  • "assigneeJoinTimestamp": 0,
  • "activationTimestamp": 0,
  • "offboardingTimestamp": 0,
  • "endTimestamp": 0,
  • "state": "CREATED",
  • "initialEngagementType": "CHAT_REQUEST",
  • "endReason": "ENDED_BY_PARTICIPANT",
  • "tokboxSessionId": "string",
  • "conversationTemplateId": "string"
}
$_type
string
Default: "ConversationHistoryMessageData"
Value: "ConversationHistoryMessageData"
id
string

ID of the message.

conversationId
string

ID of the conversation to which this message belongs.

sendTimestamp
integer <int64>

UTC time stamp when the message was sent from the client.

serverTimestamp
integer <int64>

UTC time stamp when the message was received on the Unblu server.

senderPersonId
string

ID of the person that send the message. May be null for system messages.

type
string (EMessageType)
Enum: "TEXT" "FILE" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED"

The message type of a conversation message

recipientPersonIds
Array of strings

IDs of persons that the message was addressed to.

If it is null, all active participations are regarded as recipients.

text
string

Text representation of the message.

{
  • "$_type": "ConversationHistoryMessageData",
  • "id": "string",
  • "conversationId": "string",
  • "sendTimestamp": 0,
  • "serverTimestamp": 0,
  • "senderPersonId": "string",
  • "type": "TEXT",
  • "recipientPersonIds":
    [
    ],
  • "text": "string"
}
$_type
string
Default: "AccountData"
AccountData
AccountData
NamedAreaData
PersonData
TeamData
id
string

Unique id of the account.

displayName
string

Display-Name of the account

string or Avatar (object)

Avatar of the account: id that can be expanded.

Example
AccountData
AccountData
NamedAreaData
PersonData
TeamData
{
  • "$_type": "AccountData",
  • "id": "string",
  • "displayName": "string",
  • "avatar": "string"
}
$_type
string
Default: "ConversationTemplate"
Value: "ConversationTemplate"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

name
string

Name of the named area. Maximum of 250 characters. Can not be omitted.

description
string

Description of the named area. Maximum of 500 characters. Can be omitted.

defaultTemplate
boolean

If true, this will be the default template for the initial engagement Type

initialEngagementType
string (EInitialEngagementType)
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

object
object
object
{
  • "$_type": "ConversationTemplate",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "description": "string",
  • "defaultTemplate": true,
  • "initialEngagementType": "CHAT_REQUEST",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}
$_type
string
Default: "ConversationUpdatedEvent"
Value: "ConversationUpdatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (ConversationData)

Metadata information about a conversation

{
  • "$_type": "ConversationUpdatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "conversation":
    {
    }
}
personId
string
{
  • "personId": "string"
}
reason
string (EConversationEndReason)
Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "OTHER"

Closing reason of a conversation

comment
string
{
  • "reason": "ENDED_BY_PARTICIPANT",
  • "comment": "string"
}
personId
string
reason
string (EConversationLeftReason)
Enum: "FORWARDED" "PARTICIPANT_LEFT" "REMOVED_AFTER_TIMEOUT" "ONBOARDING_DECLINED" "USER_CHANGED" "KICKED" "OTHER"

Participation left reason of a conversation

comment
string
{
  • "personId": "string",
  • "reason": "FORWARDED",
  • "comment": "string"
}
personId
string
{
  • "personId": "string"
}
personId
string
{
  • "personId": "string"
}
$_type
string
Default: "Domain"
Value: "Domain"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

domainName
string

The name/adress of the domain. It should normally contain a protocol (e.g. http:// or https://) and the url of the domain (e.g. www.unblu.com). Maximum of 250 characters. Can not be omitted. 250 characters.

{
  • "$_type": "Domain",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "domainName": "string"
}
$_type
string
Default: "DomainModificationEvent"
Value: "DomainModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (Domain)

Model of a domain

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "DomainModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}
string
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

"SUPER_ADMIN"
string
Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL"

Type of a contact information

"UNKNOWN_PHONE"
string
Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "OTHER"

Closing reason of a conversation

"ENDED_BY_PARTICIPANT"
string
Enum: "FORWARDED" "PARTICIPANT_LEFT" "REMOVED_AFTER_TIMEOUT" "ONBOARDING_DECLINED" "USER_CHANGED" "KICKED" "OTHER"

Participation left reason of a conversation

"FORWARDED"
string
Enum: "ACCEPT_IN_AGENT_DESK" "ACCEPT_IN_AGENT_SINGLE_VIEW" "ACCEPT_IN_VISITOR_DESK" "OPEN_IN_AGENT_DESK" "OPEN_IN_AGENT_SINGLE_VIEW" "OPEN_IN_VISITOR_DESK"

Type of link used to accept an invitation.

"ACCEPT_IN_AGENT_DESK"
string
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

State of participation

"CREATED"
string
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

Life cycle state of the conversation

"CREATED"
string
Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "CHAT_INVITE" "HEADLESS_INVITE"

The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.

"CHAT_REQUEST"
string
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

"WEB_API"
string
Enum: "NO_LICENSE" "ACTIVE" "INVALID" "EXPIRED"

State of the global server license

"NO_LICENSE"
string
Enum: "TEXT" "FILE" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED"

The message type of a conversation message

"TEXT"
string
Enum: "GET" "POST" "PUT" "DELETE"

Type of a HTTP method

"GET"
string
Enum: "META_TAG" "DOMAIN"

Type of a named area

"META_TAG"
string
Enum: "USER_DB" "VIRTUAL"

The source type of a person (participant of a conversation)

"USER_DB"
string
Enum: "AGENT" "VISITOR" "SYSTEM" "BOT"

The type of a person (participant of a session)

"AGENT"
string
Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "CONVERSATION" "CONVERSATION_TEMPLATE"

Type of an owner of an entity

"GLOBAL"
string
Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE"

Possible Webhook Registration Status

"ACTIVE"
string
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

"CREATE"
$_type
string
Default: "Error"
Value: "Error"
statusCode
integer <int32>

Http status code

statusDescription
string

Reason phrase corresponding to the http status

errorMessage
string

Description of the error

{
  • "$_type": "Error",
  • "statusCode": 0,
  • "statusDescription": "string",
  • "errorMessage": "string"
}
string
Enum: "avatar" "billingAddress" "configuration" "contactAddress" "metadata" "text"
"avatar"
$_type
string
Default: "GlobalData"
Value: "GlobalData"
serverIdentifier
string

A unique id identifying an Unblu installation. This is read only information it will be set by the server anyway.

object (LicenseData)

Entity representing the current installed license

object
object
object
{
  • "$_type": "GlobalData",
  • "serverIdentifier": "string",
  • "currentLicense":
    {
    },
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}
$_type
string
Default: "ArrayBody"
ArrayBody
ArrayBody
BodyElement
Array of objects (BodyElement)
Example
ArrayBody
ArrayBody
BodyElement
{
  • "$_type": "ArrayBody",
  • "elements":
    [
    ]
}
$_type
string
Default: "LicenseData"
Value: "LicenseData"
state
string (ELicenseState)
Enum: "NO_LICENSE" "ACTIVE" "INVALID" "EXPIRED"

State of the global server license

licenseId
string

Id of the current license. Is null when no license is installed. This is read only information that will changed when a new license is installed.

expirationTimestamp
integer <int64>

utc timestamp when the current license will expires. Is null when no license is installed. This is read only information that will changed when a new license is installed.

object

features contained in the license.

{
  • "$_type": "LicenseData",
  • "state": "NO_LICENSE",
  • "licenseId": "string",
  • "expirationTimestamp": 0,
  • "features":
    {
    }
}
$_type
string
Default: "NamedArea"
Value: "NamedArea"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

name
string

Name of the named area. Maximum of 250 characters. Can not be omitted.

description
string

Description of the named area. Maximum of 500 characters. Can be omitted.

type
string (ENamedAreaType)
Enum: "META_TAG" "DOMAIN"

Type of a named area

siteId
string

Meta tag name if the type is META_TAG or domain name if the type is DOMAIN. If the type is META_TAG, it can be omitted during creation and a random ID will generated for it. Modification of this attribute is not allowed. Maximum of 250 characters.

object
object
object
{
  • "$_type": "NamedArea",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "description": "string",
  • "type": "META_TAG",
  • "siteId": "string",
  • "configuration":
    {
    },
  • "text":
    {
    },
  • "metadata":
    {
    }
}
$_type
string
Default: "NamedAreaData"
Value: "NamedAreaData"
id
string

Unique id of the named area.

accountId
string

Account id to which a named area belongs to.

displayName
string

Display-Name of the named area

string or Avatar (object)

Avatar of the named area: id that can be expanded.

{
  • "$_type": "NamedAreaData",
  • "id": "string",
  • "accountId": "string",
  • "displayName": "string",
  • "avatar": "string"
}
$_type
string
Default: "NamedAreaModificationEvent"
Value: "NamedAreaModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (NamedArea)

Model of named areas. They can either be domains or meta tags

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "NamedAreaModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}
$_type
string
Default: "ParticipantData"
Value: "ParticipantData"
state
string (EConversationParticipationState)
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

State of participation

personId
string

Id of the participant person

{
  • "$_type": "ParticipantData",
  • "state": "CREATED",
  • "personId": "string"
}
$_type
string
Default: "ParticipantHistoryData"
Value: "ParticipantHistoryData"
state
string (EConversationParticipationState)
Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED"

State of participation

createdTimestamp
integer <int64>

utc timestamp when the person participation was created (timestamp when the state was set to EConversationParticipationState.CREATED)

joinedTimestamp
integer <int64>

utc timestamp when the person has joined (timestamp when the state was set to EConversationParticipationState.ONBOARDING)

activationTimestamp
integer <int64>

utc timestamp when the participation was activated, can be null (timestamp when the state was set to EConversationParticipationState.ACTIVE)

offboardingTimestamp
integer <int64>

utc timestamp when the person started offboarding, can be null (timestamp when the state was set to EConversationParticipationState.OFFBOARDING)

leftTimestamp
integer <int64>

utc timestamp when the person has left, can be null (timestamp when the state was set to EConversationParticipationState.ENDED)

conversationRating
number <float>

Rating (between 0 and 1) for the conversation given by the participant

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "ParticipantHistoryData",
  • "state": "CREATED",
  • "createdTimestamp": 0,
  • "joinedTimestamp": 0,
  • "activationTimestamp": 0,
  • "offboardingTimestamp": 0,
  • "leftTimestamp": 0,
  • "conversationRating": 0,
  • "person":
    {
    }
}
$_type
string
Default: "Permissions"
Value: "Permissions"
allPermissions
boolean

Flag that indicates that all permissions are granted, ignoring the permissions entries

permissions
Array of strings

all permissions of the user

{
  • "$_type": "Permissions",
  • "allPermissions": true,
  • "permissions":
    [
    ]
}
$_type
string
Default: "PersonData"
Value: "PersonData"
id
string

Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway.

accountId
string

Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

personSource
string (EPersonSource)
Enum: "USER_DB" "VIRTUAL"

The source type of a person (participant of a conversation)

sourceId
string

Identifier of the person in its source (defined by personSource). For EPersonSource.USER_DB this is the userId, forEPersonSource.VIRTUAL the propagated user id.

sourceData
string

Vendor specific data.

firstName
string

The first name of the person. Maximum length of 250 characters. Can be omitted.

lastName
string

the last name of the person. Maximum length of 250 characters. Can be omitted.

username
string

The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted.

nickname
string

A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted.

displayName
string

Display name of the person. This is read only information, it will be set by the server anyway.

personType
string (EPersonType)
Enum: "AGENT" "VISITOR" "SYSTEM" "BOT"

The type of a person (participant of a session)

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

email
string

The email of the person. Optional.

phone
string

The phone of the person. Optional.

teamId
string

Team id of the person. Optional.

teamName
string

Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

{
  • "$_type": "PersonData",
  • "id": "string",
  • "accountId": "string",
  • "personSource": "USER_DB",
  • "sourceId": "string",
  • "sourceData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "displayName": "string",
  • "personType": "AGENT",
  • "authorizationRole": "SUPER_ADMIN",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "teamName": "string",
  • "avatar": "string"
}
$_type
string
Default: "PersonModificationEvent"
Value: "PersonModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (PersonData)

Representation of a Person (Agent or Visitor)

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "PersonModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}
$_type
string
Default: "PinCreatedEvent"
Value: "PinCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the pin event with the token.
Only one link can be used.

{
  • "$_type": "PinCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}
$_type
string
Default: "PinRedeemedEvent"
Value: "PinRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "PinRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0,
  • "redeemingPerson":
    {
    }
}
$_type
string
Default: "PinRenewedEvent"
Value: "PinRenewedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the visitor invitation event with the token.
Only one link can be used.

{
  • "$_type": "PinRenewedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}
$_type
string
Default: "PinRevokedEvent"
Value: "PinRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

{
  • "$_type": "PinRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "expirationTimestamp": 0
}
$_type
string
Default: "ProductVersion"
Value: "ProductVersion"
productVersion
string

The version of the product

productGuid
string

The unique identifier of the product build

{
  • "$_type": "ProductVersion",
  • "productVersion": "string",
  • "productGuid": "string"
}
$_type
string
Default: "QueryParameter"
Value: "QueryParameter"
documentation
string

Documentation of the query parameter

name
string

Name of the query parameter

type
string

Type of the query parameter

{
  • "$_type": "QueryParameter",
  • "documentation": "string",
  • "name": "string",
  • "type": "string"
}
$_type
string
Default: "ResourceMetadata"
Value: "ResourceMetadata"
documentation
string

Documentation of the resource

requiredRole
Array of strings

Role required to call the resource. One Of EAuthorizationRole

requiredCallOrigin
string

Origin required to call the resource. One of EOrigin

Array of objects (ResourcePathElement)

path to the resource. For the url each path element can be separated by /

Array of objects (QueryParameter)

Query parameters for the call

any (IBody)

Body representation of WebApiService's. Can either be a single BodyElement or a list of elements wrapped inside an ArrayBody

returnDocumentation
string

Documentation of the return value

object (ServiceTypeBinding)

Representation of type binding. It reference either to a ServiceType or a simple well known type

isGetAll
boolean

Defines if the resource is a listing resource. In this case its call ends with a / (e.g. rest/v1/accounts/)

methodType
string (EMethodType)
Enum: "GET" "POST" "PUT" "DELETE"

Type of a HTTP method

{
  • "$_type": "ResourceMetadata",
  • "documentation": "string",
  • "requiredRole":
    [
    ],
  • "requiredCallOrigin": "string",
  • "path":
    [
    ],
  • "queryParameters":
    [
    ],
  • "body":
    {
    },
  • "returnDocumentation": "string",
  • "returnType":
    {
    },
  • "isGetAll": true,
  • "methodType": "GET"
}
$_type
string
Default: "ResourcePathElement"
Value: "ResourcePathElement"
documentation
string

Documentation of the element

name
string

Name of the path element

dynamic
boolean

True if it is a variable part

type
string

Type of the element

{
  • "$_type": "ResourcePathElement",
  • "documentation": "string",
  • "name": "string",
  • "dynamic": true,
  • "type": "string"
}
$_type
string
Default: "ServiceType"
Value: "ServiceType"
documentation
string

Documentation of the type

name
string

The name of the type

implementationName
string

Name of the service inside unblu. Only needed to match references in documentation

isEnum
boolean

True if the type is an enum

additionalExpandables
Array of strings

Name of the properties that can be expanded to the type

Array of objects (ServiceTypeProperty)

All properties of the type

Array of objects (ServiceTypeProperty)

Static properties of the type. Mainly used for enum constants

Array of objects (ServiceTypeBinding)

If this type is an interface, list of types that implement it.

{
  • "$_type": "ServiceType",
  • "documentation": "string",
  • "name": "string",
  • "implementationName": "string",
  • "isEnum": true,
  • "additionalExpandables":
    [
    ],
  • "properties":
    [
    ],
  • "staticProperties":
    [
    ],
  • "implementationTypes":
    [
    ]
}
$_type
string
Default: "ServiceTypeBinding"
Value: "ServiceTypeBinding"
typeName
string

Name of the type

isArray
boolean

True if the type is an array

numArrayDim
integer <int32>

0 if type is not an array. Otherwise the property defines the number of dimension of the property. E.g. with 2 a string type would be a 2 dim string array: string[][]

isEnum
boolean

True if the type is an enum

Array of objects (ServiceTypeBinding)

Type arguments for generic types. E.g. a list has generic types: list<string> generic type would be string

{
  • "$_type": "ServiceTypeBinding",
  • "typeName": "string",
  • "isArray": true,
  • "numArrayDim": 0,
  • "isEnum": true,
  • "typeArgs":
    [
    ]
}
$_type
string
Default: "ServiceTypeProperty"
Value: "ServiceTypeProperty"
typeName
string

Name of the type

isArray
boolean

True if the type is an array

numArrayDim
integer <int32>

0 if type is not an array. Otherwise the property defines the number of dimension of the property. E.g. with 2 a string type would be a 2 dim string array: string[][]

isEnum
boolean

True if the type is an enum

Array of objects (ServiceTypeBinding)

Type arguments for generic types. E.g. a list has generic types: list<string> generic type would be string

documentation
string

Documentation of the property

name
string

name of the property

expandableType
string

type if this property represent an id that can be expanded

{
  • "$_type": "ServiceTypeProperty",
  • "typeName": "string",
  • "isArray": true,
  • "numArrayDim": 0,
  • "isEnum": true,
  • "typeArgs":
    [
    ],
  • "documentation": "string",
  • "name": "string",
  • "expandableType": "string"
}
$_type
string
Default: "ServiceWebhookEventType"
Value: "ServiceWebhookEventType"
documentation
string

Documentation of the webhook event

name
string

Name of the event

implementationName
string

Name of the service inside unblu. Only needed to match references in documentation

Array of objects (ServiceTypeProperty)

Properties of the event

Array of objects (ServiceTypeProperty)

Static properties of the event. They are not send

{
  • "$_type": "ServiceWebhookEventType",
  • "documentation": "string",
  • "name": "string",
  • "implementationName": "string",
  • "properties":
    [
    ],
  • "staticProperties":
    [
    ]
}
$_type
string
Default: "ServicesContainer"
Value: "ServicesContainer"
version
string

Version of the metadata

Array of objects (WebApiService)

All services

Array of objects (ServiceWebhookEventType)

All webhook events

Array of objects (ServiceType)

All types used in the services and webhook events

{
  • "$_type": "ServicesContainer",
  • "version": "string",
  • "services":
    [
    ],
  • "webhookEvents":
    [
    ],
  • "types":
    [
    ]
}
$_type
string
Default: "Team"
Value: "Team"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

name
string

Name of the team. Maximum of 250 characters. Can not be omitted.

parentId
string

Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server.

description
string

Description of the team. Maximum of 500 characters. Can be omitted.

object
object
{
  • "$_type": "Team",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}
$_type
string
Default: "TeamData"
Value: "TeamData"
id
string

Unique id of the team.

accountId
string

Account id to which a team belongs to.

displayName
string

Display-Name of the team

string or Avatar (object)

Avatar of the team: id that can be expanded.

parentId
string

Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server.

{
  • "$_type": "TeamData",
  • "id": "string",
  • "accountId": "string",
  • "displayName": "string",
  • "avatar": "string",
  • "parentId": "string"
}
$_type
string
Default: "TeamModificationEvent"
Value: "TeamModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (Team)

Model of a team. A team consist out of multiple users. For each account there is at least the default team.

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "TeamModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}
$_type
string
Default: "User"
Value: "User"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

string or Avatar (object)

Avatar of the entity: id that can be expanded.

username
string

The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address.

email
string

The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used.

phone
string

The phone number of the user. Maximum length of 100 characters.

teamId
string

The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account.

authorizationRole
string (EAuthorizationRole)
Enum: "SUPER_ADMIN" "PARTNER" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER"

The authorization role is mainly used for access definition of a service

displayName
string

The display name of the user. Will be calculated by the server. Can be omitted while creating a user.

firstName
string

The first name of the user. Maximum length of 250 characters. Can not be omitted.

lastName
string

the last name of the user. Maximum length of 250 characters. Can not be omitted.

object
object
{
  • "$_type": "User",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "avatar": "string",
  • "username": "string",
  • "email": "string",
  • "phone": "string",
  • "teamId": "string",
  • "authorizationRole": "SUPER_ADMIN",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "configuration":
    {
    },
  • "metadata":
    {
    }
}
$_type
string
Default: "UserInfo"
Value: "UserInfo"
userId
string

The id of the user

userName
string

The username of the user

firstName
string

The first name of the user

lastName
string

The last name of the user

displayName
string

The display name of the user

{
  • "$_type": "UserInfo",
  • "userId": "string",
  • "userName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string"
}
$_type
string
Default: "UserModificationEvent"
Value: "UserModificationEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

action
string (EntityModificationAction)
Enum: "CREATE" "UPDATE" "DELETE"

Type of modification of an entity

object (User)

Model of a user. A user is normally an agent and/or a person who manages the system

object (UserInfo)

User information which are normally used together with webhook events.

{
  • "$_type": "UserModificationEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "action": "CREATE",
  • "entity":
    {
    },
  • "editingUser":
    {
    }
}
$_type
string
Default: "UserPasswordContainer"
Value: "UserPasswordContainer"
object (User)

Model of a user. A user is normally an agent and/or a person who manages the system

password
string

The password which belongs to the user

{
  • "$_type": "UserPasswordContainer",
  • "user":
    {
    },
  • "password": "string"
}
userId
string

The id of the user which should be updated

password
string

The new password for the user

{
  • "userId": "string",
  • "password": "string"
}
$_type
string
Default: "VisitorInvitationCreatedEvent"
Value: "VisitorInvitationCreatedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the visitor invitation event with the token.
Only one link can be used.

{
  • "$_type": "VisitorInvitationCreatedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}
$_type
string
Default: "VisitorInvitationRedeemedEvent"
Value: "VisitorInvitationRedeemedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

object (PersonData)

Representation of a Person (Agent or Visitor)

{
  • "$_type": "VisitorInvitationRedeemedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0,
  • "redeemingPerson":
    {
    }
}
$_type
string
Default: "VisitorInvitationRenewedEvent"
Value: "VisitorInvitationRenewedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

Array of objects (ConversationLink)

List of links that can be used to accept the visitor invitation event with the token.
Only one link can be used.

{
  • "$_type": "VisitorInvitationRenewedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0,
  • "links":
    [
    ]
}
$_type
string
Default: "VisitorInvitationRevokedEvent"
Value: "VisitorInvitationRevokedEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

invitationId
string

Id of the invitation

conversationId
string

Id of the conversation

token
string

Token (digits for pin or character sequence) requested to redeem or revoke the invitation

dateCreated
integer <int64>

Unix timestamp when the event was created

creatorType
string (EInvitationCreatorType)
Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR"

Type of creator for invitation

object (PersonData)

Representation of a Person (Agent or Visitor)

email
string

Visitor email

expirationTimestamp
integer <int64>

Unix timestamp after witch the invitation is no longer valid

{
  • "$_type": "VisitorInvitationRevokedEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "invitationId": "string",
  • "conversationId": "string",
  • "token": "string",
  • "dateCreated": 0,
  • "creatorType": "WEB_API",
  • "creatorPerson":
    {
    },
  • "email": "string",
  • "expirationTimestamp": 0
}
$_type
string
Default: "WebApiService"
Value: "WebApiService"
documentation
string

Documentation of the service

name
string

Name of the service

implementationName
string

Name of the service inside unblu. Only needed to match references in documentation

Array of objects (ResourceMetadata)

All resources of the service

{
  • "$_type": "WebApiService",
  • "documentation": "string",
  • "name": "string",
  • "implementationName": "string",
  • "resources":
    [
    ]
}
$_type
string
Default: "WebhookCallLog"
Value: "WebhookCallLog"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

registrationId
string

Id of the webhook registration

requestId
string

Id of the request id created for the request to the webhook

executionTimestamp
integer <int64>

utc timestamp when the request to the webhook was executed

endpoint
string

The webhook endpoint which was requested

retryNr
integer <int64>

The number of reqeuest retries done to the webhook

callId
string

The id of the call

eventName
string

The name of the webhook event

requestHeaders
string

The request headers send with the webhook event

requestSent
string

The full send request

requestSentTableColumn
string

If the request data were larger then 2000 bytes, the first 2000 bytes are stored in this field. The other part is stored in the blob-store. SeerequestFileStoreId.

requestFileStoreId
string

If the request data were larger then 2000 bytes, the first 2000 btes are stored in requestSentTableColumn. The others are stored behind this blob store id.

httpResponseCode
integer <int32>

HTTP response code of the request to the webhook

httpResponseReason
string

HTTP response reason of the request to the webhook

httpResponseHeaders
string

HTTP response header of the request to the webhook

responseFromServer
string

Full Response data returned for the request to the webhook.

responseFromServerTableColumn
string

If the response to the webhook was larger then 2000 bytes, the first 2000 bytes are stored in this field. The others are stored in theresponseFileStoreId

responseFileStoreId
string

If the response to the webhook was larger then 2000 bytes, the first 2000 bytes are stored inside responseFromServerTableColumn. The others are stored behind this blob store id.

{
  • "$_type": "WebhookCallLog",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "registrationId": "string",
  • "requestId": "string",
  • "executionTimestamp": 0,
  • "endpoint": "string",
  • "retryNr": 0,
  • "callId": "string",
  • "eventName": "string",
  • "requestHeaders": "string",
  • "requestSent": "string",
  • "requestSentTableColumn": "string",
  • "requestFileStoreId": "string",
  • "httpResponseCode": 0,
  • "httpResponseReason": "string",
  • "httpResponseHeaders": "string",
  • "responseFromServer": "string",
  • "responseFromServerTableColumn": "string",
  • "responseFileStoreId": "string"
}
$_type
string
Default: "WebhookPingEvent"
Value: "WebhookPingEvent"
timestamp
integer <int64>

The time (unix time in millies) that the event was generated.

eventType
string

The name of the event

accountId
string

The account ID the event originated from.

object (WebhookRegistration)

Model of a webhook registration. Registered webhooks for certain events are stored inside this model.

{
  • "$_type": "WebhookPingEvent",
  • "timestamp": 0,
  • "eventType": "string",
  • "accountId": "string",
  • "webhookConfiguration":
    {
    }
}
$_type
string
Default: "WebhookRegistration"
Value: "WebhookRegistration"
id
string

Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway.

dateCreated
integer <int64>

Creation date of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

dateModified
integer <int64>

Date of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency.

version
integer <int64>

Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted.

accountId
string

Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send.

name
string

Name of the webhook registration. Maximum length of 250 characters. Can not be omitted.

status
string (ERegistrationStatus)
Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE"

Possible Webhook Registration Status

description
string

Description of the webhook registration. Maximum length of 500 characters. Can be omitted.

endpoint
string

The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can be omitted, but should not.

secret
string

A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted.

events
Array of strings

Events for which the webhook endpoint is called, if they occur. Can not be omitted. Check the Webhook Events for possible values.

{
  • "$_type": "WebhookRegistration",
  • "id": "string",
  • "dateCreated": 0,
  • "dateModified": 0,
  • "version": 0,
  • "accountId": "string",
  • "name": "string",
  • "status": "ACTIVE",
  • "description": "string",
  • "endpoint": "string",
  • "secret": "string",
  • "events":
    [
    ]
}
id
string

Id of the registration to send the ping webhook to.

{
  • "id": "string"
}