Versão de assinatura do evento

O Workfront tem duas versões de assinaturas de evento. Este artigo descreve as diferenças entre elas.

A nova versão não é uma alteração na API do Workfront, mas uma alteração na funcionalidade de assinatura do evento.

A capacidade de atualizar ou fazer downgrade de assinaturas de eventos garante que, quando alterações forem feitas na estrutura dos eventos, as assinaturas existentes não sejam interrompidas, permitindo testar e atualizar para a nova versão sem uma lacuna na assinatura do evento.

Ao atualizar ou fazer downgrade da assinatura de evento para outra versão, você recebe eventos duplicados para cada entrega de evento por uma janela de cinco minutos após a alteração da versão. As duplicatas incluem uma de cada versão de assinatura de evento 1 e versão 2. Isso garante que você não perca nenhum evento devido à alteração da versão de assinatura do evento.

Para obter informações sobre os pontos de extremidade usados para atualizar ou rebaixar assinaturas de eventos, consulte Versão de assinatura de eventos no artigo API de assinatura de eventos.

IMPORTANT
As seguintes versões afetarão o controle de versão de assinaturas de eventos:
  • 25.2 Versão (10 de abril de 2025): todas as novas assinaturas criadas após a versão 25.2 são criadas como Versão 2.
  • 15 de janeiro de 2026: todas as assinaturas restantes da versão 1 são migradas para a versão 2.

Alterações entre a versão 1 e a versão 2

As seguintes alterações foram feitas para assinaturas de evento Versão 2:

Alterações gerais

Campos afetados
Versão 1 (comportamento anterior)
Versão 2 (Alterar)
Ação de remediação
Valores de parâmetro calculados
Qualquer objeto criado a partir de um modelo que incluísse um formulário personalizado com valores de parâmetro calculados, um evento CREATE seria enviado e um UPDATE seria enviado com os valores de parâmetro (incluindo campos calculados e seus valores).
Quando um objeto é criado a partir de um modelo que inclui um formulário personalizado com valores de parâmetro calculados, somente um evento CREATE será enviado e conterá valores de parâmetro, incluindo campos calculados.
Se você tiver uma assinatura para UPDATE eventos e estiver esperando receber um evento UPDATE depois que um objeto for criado com valores de parâmetro calculados, você não receberá mais esse evento UPDATE. Se quiser ver valores de parâmetros calculados na criação de objetos, você deve criar uma assinatura CREATE adicional.
Campos do tipo Seleção múltipla

Para qualquer tipo de evento que contenha uma alteração em um campo de tipo de seleção múltipla, se o campo contivesse apenas um valor, ele seria convertido em e enviado como uma string. Caso contrário, ele será enviado como uma matriz.

Exemplos:

  • myMultiSelectField: ["oneValue"] é convertido e enviado como myMultiSelectField: "oneValue".
  • myMultiSelectField: ["first", "second"] é enviado como myMultiSelectField: ["first", "second"].

Independentemente de quantos valores existam na matriz, ela será enviada como uma matriz.

Exemplos:

  • myMultiSelectField: ["oneValue"] é enviado como myMultiSelectField: ["oneValue"].
  • myMultiSelectField: ["first", "second"] é enviado como myMultiSelectField: ["first", "second"].
Se você tiver uma assinatura com um filtro em um campo de seleção múltipla e o valor como uma cadeia de caracteres, deverá criar uma nova assinatura com o mesmo filtro que tem o valor como uma matriz.

Alterações específicas do objeto

Código do objeto
Campos afetados
Versão 1 (comportamento anterior)
Versão 2 (Alterar)
Ação de correção
ATRIBUIR
  • projectID
  • taskID
  • opTaskID
  • customerID
Quando este objeto é atualizado, o evento UPDATE às vezes mostra incorretamente que os campos afetados mudam de null para ID value.
Todos os eventos UPDATE mostram o valor correto para os campos afetados.
Nenhum. Se você tiver um filtro nos campos afetados, receberá um evento UPDATE somente se esses campos tiverem sido realmente alterados, não se qualquer outro valor tiver sido alterado.
DOCU
  • referenceObjID
Quando qualquer valor de parâmetro é atualizado neste objeto, o evento UPDATE mostra incorretamente a alteração do campo afetado de null para object id.
Todos os eventos UPDATE mostram o valor correto para os campos afetados.
Nenhum. Se você tiver um filtro nos campos afetados, receberá um evento UPDATE somente se esses campos tiverem sido realmente alterados, não se qualquer outro valor tiver sido alterado.
  • groups
Quando um documento foi excluído, o evento DELETE mostrava incorretamente o campo afetado como uma matriz vazia no estado anterior.
O evento DELETE mostra corretamente o campo afetado no estado anterior.
Nenhum. O evento DELETE ainda será enviado, mas agora mostra os dados corretos para o campo afetado.
DOCV
  • proofDecision
  • proofName
  • proofProgress
Quando este objeto for atualizado, dois eventos UPDATE serão enviados. O primeiro não incluiu os campos afetados, enquanto o segundo evento incluiu.
Todas as atualizações de campo, incluindo os campos afetados, estão presentes em apenas um evento UPDATE, e um segundo evento desnecessário não é enviado.
Nenhum. Se você tiver um filtro nos campos afetados, os eventos serão entregues no primeiro evento.
EXPNS
  • topReferenceObjCode
  • referenceObjectName
Quando qualquer valor de parâmetro é atualizado em uma Despesa, o evento UPDATE mostra incorretamente a alteração de topReferenceObjCode de EXPNS para PROJ e a alteração de referenceObjectName de null para string value of project name.
Todos os eventos UPDATE mostram o valor correto para os campos afetados.
Nenhum. Se você tiver um filtro nos campos afetados, receberá um evento UPDATE somente se esses campos tiverem sido realmente alterados, não se qualquer outro valor tiver sido alterado.
  • topReferenceObjCode
  • referenceObjectName
Quando um objeto Expense era excluído, um evento UPDATE era enviado alterando os campos afetados para null antes do envio do evento DELETE.
O evento UPDATE extra não é enviado. O evento DELETE tem valores corretos para os campos afetados no estado anterior.
Se você tiver um filtro para os campos afetados em UPDATE eventos e estiver esperando recebê-lo quando o objeto for excluído, você não receberá mais esse evento UPDATE. Para ver esses campos quando o objeto for excluído, crie uma assinatura DELETE adicional.
HORA
  • projectID
  • taskID
  • roleID
  • timesheetID
  • hourTypeID
  • projectOverheadID
  • referenceObjID
  • referenceObjCode
  • securityRootID
Quando este objeto foi excluído, o evento DELETE mostrava incorretamente os campos afetados como null no estado anterior.
O evento DELETE mostra corretamente os campos afetados no estado antes.
Nenhum. O evento DELETE ainda é enviado, mas agora mostra os dados corretos para os campos afetados.
OPTASK
  • rootGroupID
Quando qualquer valor de parâmetro é atualizado neste objeto, o evento UPDATE mostra incorretamente a alteração do campo afetado de null para ID value.
Todos os eventos UPDATE mostram o valor correto para o campo afetado.
Nenhum. Se você tiver um filtro no campo afetado, você receberá um evento UPDATE somente se esse campo tiver sido realmente alterado, não se qualquer outro valor de parâmetro tiver sido alterado.
  • resolveProjectID
  • resolveTaskID
  • resolvingObjID
Quando este objeto é atualizado, o evento UPDATE às vezes mostra incorretamente que os campos afetados mudam de null para ID value.
Todos os eventos UPDATE mostrarão o valor correto para os campos afetados.
PROJ
  • rootGroupID
Quando qualquer valor de parâmetro é atualizado neste objeto, o evento UPDATE mostra incorretamente a alteração do campo afetado de null para ID value.
Todos os eventos UPDATE mostram o valor correto para o campo afetado.
Nenhum. Se você tiver um filtro no campo afetado, você receberá um evento UPDATE somente se esse campo tiver sido realmente alterado, não se qualquer outro valor de parâmetro tiver sido alterado.
  • convertedOpTaskID
Quando este objeto é atualizado, o evento UPDATE às vezes mostra incorretamente que os campos afetados mudam de null para ID value.
Todos os eventos UPDATE mostram o valor correto para o campo afetado.
Nenhum. Se você tiver um filtro no campo afetado, você receberá um evento UPDATE somente se esse campo tiver sido realmente alterado, não se qualquer outro valor de parâmetro tiver sido alterado.
TAREFA
  • rootGroupID
Quando qualquer valor de parâmetro é atualizado neste objeto, o evento UPDATE mostra incorretamente a alteração do campo afetado de null para ID value.
Todos os eventos UPDATE mostram o valor correto para o campo afetado.
Nenhum. Se você tiver um filtro no campo afetado, você receberá um evento UPDATE somente se esse campo tiver sido realmente alterado, não se qualquer outro valor de parâmetro tiver sido alterado.
  • convertedOpTaskID
Quando este objeto é atualizado, o evento UPDATE às vezes mostra incorretamente que os campos afetados mudam de null para ID value.
Todos os eventos UPDATE mostram o valor correto para o campo afetado.
Nenhum. Se você tiver um filtro no campo afetado, você receberá um evento UPDATE somente se esse campo tiver sido realmente alterado, não se qualquer outro valor de parâmetro tiver sido alterado.

Atualizar a versão de assinatura de evento em um cenário do Workfront Fusion

O Workfront Fusion usa assinaturas de eventos para observar alterações no Workfront a fim de acionar cenários. Você pode atualizar a versão de assinatura de evento que o Fusion usa diretamente em um cenário, usando o módulo Workfront > Atualizar versão de payload de eventos.

Para obter instruções sobre como usar este módulo, consulte Módulos do Workfront na documentação do Workfront Fusion.

Para obter recursos sobre como preservar seus cenários do Workfront Fusion durante a atualização da assinatura do evento, incluindo uma gravação de webinário, consulte Preservando seus cenários do Fusion Durante a Atualização da V2 de Assinaturas do Evento.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43