{
   "$schema":"http://json-schema.org/draft-07/schema#",
   "description":"Pizza Order Schema",
   "title":"Pizza Order Schema",
   "type":"object",
   "properties":{
      "size":{
         "description":"The pizza size",
         "type":"string"
      },
      "orderid":{
         "description":"The pizza orderid",
         "type":"string"
      },
      "type":{
         "description":"The pizza type",
         "type":"string"
      },
      "topping":{
         "description":"The pizza topping",
         "type":"string"
      }
   }
}

Para que a habilidade responda ao evento, adicione um fluxo para esse evento e use um estado Notificar Usuário para exibir uma mensagem quando o evento ocorrer:

1. Na habilidade que você deseja usar o evento, clique em e, em seguida, clique em + Adicionar Fluxo.
2. Digite um nome de fluxo e clique em Criar.
3. Clique no menu no início do fluxo e, em seguida, clique em Adicionar Estado Inicial para abrir a caixa de diálogo Adicionar Estado.
   
   
   
   
4. Selecione Integração de Serviço > Notificar Usuário, preencha um nome para o estado e clique em Inserir.
5. No inspetor de propriedades do estado Notificar Usuário inserido, selecione a guia Componente e preencha o campo Mensagem de Notificação com uma mensagem que você deseja que o usuário veja quando o evento ocorre.

   Na mensagem, você pode usar expressões no seguinte formato para acessar dados do evento:

   ${skill.system.event.value.application.data.<propertyName>}

   Observação
   
   Você também pode acessar informações de contexto do evento usando o seguinte tipo de expressão:

   ${skill.system.event.value.application.context.<attributeName>}

   Consulte Atributos de Contexto do Evento para obter informações sobre os atributos de contexto disponíveis.
6. Opcionalmente, preencha a propriedade ID do Usuário com um ID para um usuário específico que você pode determinar dinamicamente de dentro do fluxo (como por meio de um componente personalizado). Essa propriedade será útil principalmente se o ID do usuário não for enviado no payload do evento e se o usuário for um usuário unificado que foi autenticado por meio de uma Autorização usando o componente OAuth 2.0 em que a propriedade Associar ao Usuário Unificado foi definida como verdadeira. Consulte Configurando a Identidade do Usuário Unificado para obter mais informações sobre usuários unificados.

Se o evento precisar ser direcionado a um usuário específico, mas esse usuário não for especificado no próprio evento, talvez seja possível determinar o usuário no fluxo que trata o evento. Estas são as etapas gerais para fazer esse trabalho:

1. No início do fluxo que trata o evento, adicione um componente personalizado que determine o ID do usuário (com base na carga útil do evento e/ou em alguma lógica personalizada) e atribua esse ID a uma variável.
2. Após o estado do componente personalizado, insira um componente Notificar Usuário e defina a propriedade ID do Usuário desse componente para a variável retornada pelo componente personalizado.

Para que uma habilidade receba um evento, você cria um handler de eventos para esse evento no Fluxo Principal. No processador de eventos, mapeie o evento para o fluxo que contém o estado Notificar Usuário que você criou para receber o evento:

1. Na lista de fluxos, selecione Fluxo Principal.
2. Na guia Eventos desse fluxo, ao lado da seção Eventos de Aplicativo, clique em .
3. Na caixa de diálogo Criar Handler de Eventos do Aplicativo, selecione o tipo de evento, a versão do tipo de evento e o fluxo para o qual você deseja mapear o evento e clique em Fechar.
   Observação
   
   Somente tipos de evento finalizados são oferecidos no campo Tipo de Evento Não Resolvido.

Para que uma habilidade consuma um evento externo, ela deve fazer parte de um assistente digital. Para adicionar uma habilidade configurada para consumir um evento em um assistente digital:

1. Clique em para abrir o menu lateral, selecione Development > Digital Assistants e clique duas vezes no assistente digital que você deseja usar.

2. Clique em Adicionar Habilidade.

3. No mosaico da habilidade configurada para consumir o evento, selecione .

   Se você não encontrar a habilidade que está procurando, ela poderá ter um modo de idioma que não seja compatível com o modo de idioma do seu assistente digital. Consulte Condições para Adicionar uma Habilidade a um Assistente Digital.

4. Clique no botão Concluído para fechar o Catálogo de Habilidades e exibir a página da habilidade no assistente digital.

5. Role para baixo até a seção Modelo de Interação da página e certifique-se de que o valor Chamada seja o nome que você deseja que os usuários utilizem para chamar a habilidade.

   Esse nome deve seguir estas Diretrizes de Nome de Chamada.

6. Forneça alguns exemplos de declarações que seriam típicas de como um usuário chamaria a habilidade.

   Essas declarações serão usadas como opções selecionáveis nos estados de boas-vindas e ajuda padrão do assistente digital.

O exemplo a seguir mostra o uso de formulário estruturado para enviar eventos:

curl --location --request POST 'https://<server>/events/v2/listeners/appevent/channels/<id>' \
--header 'Content-Type: application/cloudevents+json' \
--header 'X-Hub-Signature: sha256=<SHA256 encoded request body using the channel's secret key>' \
--data-raw \

'{
    "specversion": "1.0",           //Version # of Digital Assistant's Events support
    "type": "<event_name>",         //The event type that the skill is listening for
    "source": "< event source>",    //URI-reference - identifies the context in which an event happened
    "id": "<event id>",             //Unique id for the event
    "version":"<event version>",    //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "data": {                       //The business data that matches with the schema defined for the event  
           
          }
}'

async pushEvent(eventName, eventVersion, userId, channelName, eventData){
  try {

    // Build event data
    const event = {
      specversion: "1.0",           //Version # of Digital Assistant's Events support
      type: eventName, // Name of Event you created in ODA
	  source: "< event source>",    //URI-reference - identifies the context in which an event happened
      id: "<event id>",             //Unique id for the event
      time: "2022-09-07T21:19:24Z", // Any Date value will do now
      channelname: <channelName>,   // Can be set to System_Global_Test if you want to test in tester
      version: <eventVersion>, // version of the event that you defined in Digital Assistant
      userid: <userId>,
      datacontenttype: "application/json",
      data: <eventData> // JSON object represting your payload which should confirm to the event's JSON schema
    };

    // Build Required headers
    const headers = {
      "X-Hub-Signature" : this._buildSignatureHeader(event, <EVENTS_CHANNEL_SECRET_KEY> , "utf8"),
      "Content-Type" : "application/cloudevents+json"
    };

    // POST to EVENT_LISTENER_CHANNEL_URL
    ....
    
  } catch (error) {
    logger.error(error.message);
    const errorMessage = `Error pushing event [ ${eventData} ] to Digital Assistant`;
    logger.debug(errorMessage);

    throw new Error(error.message);	
  }
}



_buildSignatureHeader(body, secret, encoding) {
  const buf = Buffer.from(JSON.stringify(body), "utf8");
  return "sha256=" + this._buildSignature(buf, secret, encoding);
}

_buildSignature(buf, secret, encoding) {
  const hmac = crypto.createHmac("sha256", Buffer.from(secret || "", encoding || "utf8"));
  if (buf) {
    hmac.update(buf);
  }
  return hmac.digest("hex");
}

Estes são atributos comuns que você pode usar em um payload de evento:

• specversion: (Obrigatório) Número da versão do suporte a Eventos do Digital Assistant. Atualmente, o único valor válido é 1.0.
• type: (Obrigatório) O tipo de evento que a habilidade está atendendo. Isso precisa corresponder ao nome do tipo de evento especificado na tarefa Definir um Tipo de Evento.
• source: (Obrigatório) Identifica o contexto no qual um evento ocorreu. Pode ser uma string de formato livre.
• id: (Obrigatório) O ID exclusivo que é gerado para o evento pelo aplicativo.
• version: (Obrigatório) O nome da versão do tipo de evento que está sendo enviado. Você deve incluir um valor para esse atributo na carga útil do evento e ele deve corresponder ao valor fornecido para a versão do tipo de evento fornecida na tarefa Criar um Handler para o Evento Externo.
  Observação
  
  Este atributo é um dos atributos de extensão, o que significa que ele não faz parte da especificação CloudEvent.
• data: (Obrigatório) Os dados de negócios que correspondem ao esquema definido para o evento.

Para cada evento gerado, o Digital Assistant adiciona atributos de extensão que descrevem o contexto no qual o evento é gerado. Ferramentas e códigos de aplicativos podem usar essas informações para identificar itens como a origem dos eventos gerados e seu relacionamento com outros eventos. Você também pode especificar valores para esses atributos na carga útil do evento.

Veja a seguir uma lista dos atributos de extensão (todos do tipo String):

• version: O nome da versão do tipo de evento que está sendo enviado. Você deve incluir um valor para esse atributo na carga útil do evento e ele deve corresponder ao valor fornecido para a versão do tipo de evento fornecida na tarefa Criar um Handler para o Evento Externo.
• userid: O ID do usuário ao qual a mensagem está sendo direcionada. Pode assumir uma das seguintes duas formas:
  • Um ID de usuário do OCI IAM. Nesse caso, você também precisa incluir o atributo usertenancy no payload.
  • Um ID de usuário fornecido pelo canal. Nesse caso, você também precisa incluir o atributo channelname no payload.
    Observação
    
    Para o Twilio, esse valor seria o número do celular do usuário.
• usertenancy: O nome da tenancy do OIC IAM do provedor de identidades do usuário.
• channelname: O nome do canal por meio do qual o assistente digital é exposto.
• tenancy: O nome da tenancy do Oracle Cloud Infrastructure para a instância do Digital Assistant. (Normalmente, você não precisaria incluir explicitamente esse atributo, pois as informações sobre a tenancy são transmitidas nos cabeçalhos de solicitação.)

{
    "specversion": "1.0",
    "type": "com.pizzastore.pizza.ordercreated",
    "source": "pizzastore/orders",
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "time": "2022-08-10T12:31:00Z",
    "contenttype": "application/json",
    "tenancy": "mydigitalassistantinstance",
    "version": "1.0",
    "data": {"size": "Large",
            "type": "Veg"
          }
}

Se precisar informar o ID de usuário do OCI IAM para o usuário no payload, você também especificará os atributos userid e usertenancy:

{
    "specversion": "1.0",           //Version # of Digital Assistant's Events support
    "type": "<event_name>",         //The event type that the skill is listening for
    "source": "< event source>",    //URI-reference - identifies the context in which an event happened
    "id": "<event id>",             //Unique id for the event
    "version":"<event version>",    //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "userid":"<IAM user id>",      //An extension attribute(not part of CloudEvent spec) for the user ID  
    "usertenancy":<IAM tenancy>",  //Extension attribute, IAM
    "data": {                       //The business data that matches with the schema defined for the event  
           
          }
}

Para assistentes digitais expostos por meio dos canais Twilio e Web, o aplicativo externo também pode notificar os usuários especificando o nome do canal e o ID do usuário fornecido pelo canal.

{
    "specversion": "1.0",            //Version # of Digital Assistant's Events support
    "type": "<name_of_event_type>",  //The event type that the skill is listening for
    "source": "< event source>",     //URI-reference - identifies the context in which an event happened
    "id": "<event id>",              //Unique id for the event
    "version":"<event version>",     //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "userid":"<channel user id>",    //An extension attribute(not part of CloudEvent spec) for the user ID
    "channelname":"<channel name>",  //Name of the channel through which the digital assistant is exposed
    "data": {                        //The business data that matches with the schema defined for the event  
           
          }
}