personalization

2.0info: 8.6.1 personalization description: Gerenciamento de personalizações x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: personalization contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /personalization/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainBackgroundImageId: post: description: Obtém o identificador e a URL para salvar a imagem de fundo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – backgroundImageId – url – version properties: backgroundImageId: type: string description: Identificador da imagem de fundo url: type: string description: URL para a qual deve ser enviada a imagem de fundo type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o identificador e a URL para salvar a imagem de fundo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – backgroundImageId – url – version properties: backgroundImageId: type: string description: Identificador da imagem de fundo url: type: string description: URL para a qual deve ser enviada a imagem de fundo type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainSmallBackgroundImageId: post: description: Obtém o identificador e a URL para salvar a imagem de fundo em tamanho pequeno tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – backgroundImageId – url – version properties: backgroundImageId: type: string description: Identificador da imagem de fundo url: type: string description: URL para a qual deve ser enviada a imagem de fundo type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o identificador e a URL para salvar a imagem de fundo em tamanho pequeno tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – backgroundImageId – url – version properties: backgroundImageId: type: string description: Identificador da imagem de fundo url: type: string description: URL para a qual deve ser enviada a imagem de fundo type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainLogoImageId: post: description: Obtém o identificador e a URL para salvar a imagem do logo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – logoImageId – url – version properties: logoImageId: type: string description: Identificador da imagem do logotipo url: type: string description: URL para a qual deve ser enviada a image do logotipo type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o identificador e a URL para salvar a imagem do logo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – logoImageId – url – version properties: logoImageId: type: string description: Identificador da imagem do logotipo url: type: string description: URL para a qual deve ser enviada a image do logotipo type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainLoginLogoImageId: post: description: Obtém o identificador e a URL para salvar a imagem do logo da tela de login tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – loginLogoImageId – url – version properties: loginLogoImageId: type: string description: Identificador da imagem do logotipo da tela de login url: type: string description: URL para a qual deve ser enviada a imagem do logotipo da tela de login type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o identificador e a URL para salvar a imagem do logo da tela de login tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – loginLogoImageId – url – version properties: loginLogoImageId: type: string description: Identificador da imagem do logotipo da tela de login url: type: string description: URL para a qual deve ser enviada a imagem do logotipo da tela de login type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainLogoPreviewImageId: post: description: Obtém o identificador e a URL para salvar a imagem de preview do logo exibido no menu tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – logoPreviewImageId – url – version properties: logoPreviewImageId: type: string description: Identificador da imagem da imagem de preview do logo url: type: string description: URL para a qual deve ser enviada a imagem do logotipo da tela de login type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o identificador e a URL para salvar a imagem de preview do logo exibido no menu tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – logoPreviewImageId – url – version properties: logoPreviewImageId: type: string description: Identificador da imagem da imagem de preview do logo url: type: string description: URL para a qual deve ser enviada a imagem do logotipo da tela de login type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainSaraImageId: post: description: Obtém o identificador e a URL para salvar a imagem pequena da SARA tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – imageId – url – version properties: imageId: type: string description: Identificador da imagem url: type: string description: URL para a qual deve ser enviada a imagem type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o identificador e a URL para salvar a imagem pequena da SARA tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – imageId – url – version properties: imageId: type: string description: Identificador da imagem url: type: string description: URL para a qual deve ser enviada a imagem type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainSaraLargeImageId: post: description: Obtém o identificador e a URL para salvar a imagem grande da SARA tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – imageId – url – version properties: imageId: type: string description: Identificador da imagem url: type: string description: URL para a qual deve ser enviada a imagem type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o identificador e a URL para salvar a imagem grande da SARA tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – imageId – url – version properties: imageId: type: string description: Identificador da imagem url: type: string description: URL para a qual deve ser enviada a imagem type: string description: Versão do objeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/requestAccessImage: post: description: Confirm and request image access uploaded tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – version properties: id: type: string description: Image identifier type: string description: Image version responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Return URL to image in AWS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Confirm and request image access uploaded tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Image identifier in: query required: true type: string – name: version description: Image version in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Return URL to image in AWS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/getCurrentPersonalizationSettings: post: description: Obtém os valores atuais para imagens e cor base do CSS, para o tenant corrente tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object allOf: – #/definitions/personalizationSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os valores atuais para imagens e cor base do CSS, para o tenant corrente tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/personalizationSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/obtainPersonalizationSettings: post: description: Obtém os valores atuais para imagens e cor base do CSS, para um determinado tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant. responses: 200: description: Ok schema: type: object allOf: – #/definitions/personalizationSettings default: description: Error response schema: #/definitions/genericError get: description: Obtém os valores atuais para imagens e cor base do CSS, para um determinado tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Nome do tenant. in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/personalizationSettings default: description: Error response schema: #/definitions/genericError /personalization/queries/getBots: post: description: Obtém os Bots cadastrados\n Os bots são ordenados pela ordem de cadastro e data de criação (ambos campos não retornados)\n O campo data de criação não pode ser alterado, ele é alimentado com a data e hora de criação do Bot\n O campo ordem de cadastro é por padrão nulo e pode ser alterado pela primitiva reorderBots\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – bots properties: bots: type: array items: type: object allOf: – #/definitions/bot minimum: 1 description: Lista de Bots cadastrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os Bots cadastrados\n Os bots são ordenados pela ordem de cadastro e data de criação (ambos campos não retornados)\n O campo data de criação não pode ser alterado, ele é alimentado com a data e hora de criação do Bot\n O campo ordem de cadastro é por padrão nulo e pode ser alterado pela primitiva reorderBots\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – bots properties: bots: type: array items: type: object allOf: – #/definitions/bot minimum: 1 description: Lista de Bots cadastrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/getAllowedEmbeddedUrls: post: description: Retorna a URLs integradas permitidas no frontend da plataforma Senior X. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – allowAllEmbeddedUrls properties: allowedUrls: type: array items: type: string description: URLs permitidas. allowAllEmbeddedUrls: type: boolean description: Todas as URLs são permitidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a URLs integradas permitidas no frontend da plataforma Senior X. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – allowAllEmbeddedUrls properties: allowedUrls: type: array items: type: string description: URLs permitidas. allowAllEmbeddedUrls: type: boolean description: Todas as URLs são permitidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/changePersonalizationSettings: post: description: Altera as imagens e a cor base do CSS, para um determinado tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – textColor properties: backgroundImageId: type: string description: Identificador da imagem de fundo backgroundImageVersion: type: string description: Versão do objeto smallBackgroundImageId: type: string description: Identificador da imagem de fundo pequena smallBackgroundImageVersion: type: string description: Versão do objeto logoImageId: type: string description: Identificador da imagem do logotipo logoImageVersion: type: string description: Versão do objeto loginLogoImageId: type: string description: Identificador da imagem do logotipo da tela de login loginLogoImageVersion: type: string description: Versão da imagem do logotipo da tela de login logoPreviewImageId: type: string description: Versão da imagem do logotipo de preview do menu logoPreviewImageVersion: type: string description: Versão da imagem do logotipo de preview do menu saraImageId: type: string description: Identificador da imagem pequena da SARA saraImageVersion: type: string description: Versão da imagem pequena da SARA saraLargeImageId: type: string description: Identificador da imagem grande da SARA saraLargeImageVersion: type: string description: Versão da imagem grande da SARA baseColor: type: string description: Cor base do CSS, em hexadecimal textColor: type: string description: Cor do texto do CSS, em hexadecimal applyGradientToLogin: type: boolean description: Indica se deve aplicar a película de cores (gradiente) na tela de login. enableNewLogo: type: boolean description: Habilita as novas dimensões do logotipo da tela de login default: false personalizationForm: type: object allOf: – #/definitions/personalizationForm description: Personalização do formulário de login responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/restoreDefaults: post: description: Restaura as imagens e a cor base do CSS padrão, para um determinado tenant tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/getPersonalizationSettings: post: description: API DEPRECIADA: Use platform/personalization/obtainPersonalizationSettings instead | DATA: 2021-01-10 | Obtém os valores atuais para imagens e cor base do CSS, para um determinado tenant tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object allOf: – #/definitions/personalizationSettings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/createBot: post: description: Cadastro de Bot tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – bot properties: bot: type: object allOf: – #/definitions/bot description: Dados de atualização do Bot responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/updateBot: post: description: Atualização de um Bot cadastrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – bot properties: bot: type: object allOf: – #/definitions/bot description: Dados de atualização do Bot responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/deleteBot: post: description: Deleta um Bot cadastrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – botId properties: botId: type: string description: Identificação do Bot responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/reorderBots: post: description: Reordenação dos Bots cadastrados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – bots properties: bots: type: array items: type: object allOf: – #/definitions/botOrder minimum: 1 description: Lista de Bots contendo a Identificação e Ordem em que o Bot deve respeitar responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /personalization/actions/updateAllowedEmbeddedUrls: post: description: Atualiza a configuração de URLs integradas permitidas no frontend da plataforma Senior X. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: allowedUrls: type: array items: type: string description: URLs permitidas. Se esse campo não for passado, ou estiver vazio, irá bloquear todas as URLs. allowAllEmbeddedUrls: type: boolean description: Todas as URLs são permitidas. Se esse campo não for passado, ou tiver o valor false, irá bloquear todas as URLs, exceto as informadas no campo allowedUrls.\n ATENÇÃO: Ao passar o valor true nesse campo, todas as URLs passarão a ser permitidas. Isso permite a criação de links que abrem sites não confiáveis dentro da plataforma. responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica o sucesso da operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN botType: description: Tipos de um Bot type: string enum: – EXTERNAL – BOT_FACTORY buttonType: description: Tipo do botão type: string enum: – PRIMARY – LIGHT userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente bot: description: Dados de cadastro do Bot type: object required: – label – botType properties: id: type: string description: Identificação do Bot label: type: string description: Descrição do Bot url: type: string description: URL do Bot externalBotId: type: string description: Identificação do Bot na Botfactory botType: type: string allOf: – #/definitions/botType description: Tipo do Bot botOrder: description: Dados utilizados para reordenação de um Bot cadastrado type: object required: – id – order properties: id: type: string description: Identificação do Bot order: type: integer format: int64 description: Ordem em que o Bot deve respeitar personalizationSettings: description: Dados com os valores atuais para imagens e cor base do CSS type: object required: – backgroundImageURL – logoImageURL – loginLogoImageURL – logoPreviewImageURL – saraImageURL – saraLargeImageURL – baseColor – textColor – urlExpiration properties: backgroundImageURL: type: string description: URL da imagem de fundo smallBackgroundImageURL: type: string description: URL da imagem de fundo em tamanho pequeno logoImageURL: type: string description: URL da imagem do logotipo loginLogoImageURL: type: string description: URL da imagem do logotipo da tela de login logoPreviewImageURL: type: string description: URL da imagem do logotipo de preview do menu saraImageURL: type: string description: URL da imagem pequena da SARA (quando a customização não existir o retorno será nulo/ausente) saraLargeImageURL: type: string description: URL da imagem grande da SARA (quando a customização não existir o retorno será nulo/ausente) baseColor: type: string description: Cor base do CSS, em hexadecimal textColor: type: string description: Cor do texto do CSS, em hexadecimal applyGradientToLogin: type: boolean description: Indica se deve aplicar a película de cores (gradiente) na tela de login. customChatbotURL: type: string description: URL que irá abrir o novo chatbot customChatbotEnabled: type: boolean description: Indica se deve abrir a URL com o novo chatbot, padrão falso default: false urlExpiration: type: string format: date-time description: Data de expiração das urls solicitadas allowedEmbeddedUrls: type: array items: type: string description: URLs permitidas. allowAllEmbeddedUrls: type: boolean description: Todas as URLs são permitidas. enableNewLogo: type: boolean description: Habilita as novas dimensões do logotipo da tela de login default: false personalizationForm: type: object allOf: – #/definitions/personalizationForm description: Personalização do formulário de login e recuperação de senha personalizationForm: description: Personalização do formulários de login e recuperação de senha type: object properties: textColor: type: string description: Cor do texto apresentado na tela de login textColorHyperlink: type: string description: Cor dos hiperlinks buttons: type: array items: type: object allOf: – #/definitions/button description: Personalização dos botões button: description: Configuração css do botão discriminator: _discriminator type: object required: – buttonType – _discriminator properties: buttonType: type: string allOf: – #/definitions/buttonType description: Tipo do botão backgroundColor: type: string description: textColor: type: string description: Cor do texto do botão borderColor: type: string description: Cor da borda do botão buttonHover: type: object allOf: – #/definitions/buttonHover description: Destaque do botão ao passar o mouse _discriminator: type: string description: buttonPrimary: description: Configuração css do botão primary allOf: – #/definitions/button – type: object buttonLight: description: Configuração css do botão light allOf: – #/definitions/button – type: object properties: borderWidth: type: integer format: int64 description: Espessura da borda do botão default: 0 buttonHover: description: Configuração css do hover discriminator: _discriminator type: object required: – _discriminator properties: textColor: type: string description: Cor do texto do botão backgroundColor: type: string description: Cor do fundo do botão borderColor: type: string description: Cor da borda do botão _discriminator: type: string description: buttonPrimaryHover: description: Configuração css hover do botão primary allOf: – #/definitions/buttonHover – type: object buttonLightHover: description: Configuração css hover do botão light allOf: – #/definitions/buttonHover – type: object notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE