Webhooks

Os Webhooks notificam e ajudam-te a recolher informações sobre os principais eventos que acontecem no seu projeto no Crowdin, como traduções concluídas ou revisão. Estas chamadas de retorno definidos pelo usuário, permitem que o Crowdin abra URLs previamente, definidas via HTTP.

Apenas os proprietários e gerentes de projetos podem registar uma webhook.

Podes configurar webhooks para esperar pelos seguintes eventos: projeto totalmente traduzido ou revisto, arquivo totalmente traduzido ou revisto, tradução adicionada, atualizada, apagada, aprovada ou não aprovada.

Visão geral

Fornece as seguintes informações para criar um webhook no Crowdin:

• Um nome para o webhook (por exemplo, “ App de projeto traduzido”).
• O URL onde a chamada de retorno deve ser enviado.
• O método de solicitação, GET ou POST, que indica a ação desejada a ser executada para um determinado recurso.
• O tipo de conteúdo (ultipart/form-data, application/json, application/x-www-form-urlencoded disponível apenas para o método de solicitação POST).
• Os eventos par postar no URL. Podes selecionar um evento ou um conjunto específico de eventos.

Adicionar Webhooks

Para configurar webhooks no Crowdin, segue essas etapas:

1. Vá para as Configurações do projeto, aba API.
2. Rola para a seção Webhooks e clica Adicionar Webhook.
3. Especifica o nome e URL do webhook para receber pedidos.
4. Seleciona um método de solicitação GET ou POST conveniente. Se selecionar POST – escolhe um tipo de conteúdo para este método de solicitação.
5. Seleciona um único evento ou conjunto de eventos para receber notificações.
6. Clica Testar para verificar qual a carga receberá.
7. Clica Adicionar para salvar as mudanças.

Eventos

Podes configurar webhooks para os seguintes eventos:

Arquivo totalmente traduzido

O webhook será acionado quando qualquer um dos seus arquivos de projeto for totalmente traduzido.

Exemplo de carga:

{
    "event": "file.translated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}}
}

Arquivo totalmente revisto

O webhook será acionado quando qualquer um dos seus arquivos de projeto for totalmente revisto.

Exemplo de carga:

{
    "event": "file.approved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}}
}

Projeto totalmente traduzido

O webhook será enviado quando todas as frases do projeto forem traduzidas.

Exemplo de carga:

{
    "event": "project.translated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}}
}

Projeto totalmente revisto

O webhook será enviado quando todas as frases do projeto forem revisadas.

Exemplo de carga:

{
    "event": "project.approved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}}
}

Tradução exportada atualizada

O webhook será enviado quando a tradução final de um texto for atualizado.

Exemplo de carga:

{
    "event": "translation.updated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "source_string_id": {{source_string_identifier}},
    "old_translation_id": {{old_translation_identifier}},
    "new_translation_id": {{new_translation_identifier}},
    "user": {{user_name}},
    "user_id" {{user_identifier}},
    "file_id": {{file_identifier}},
    "file": {{file_name}}
}

Sugestão de tradução adicionada

O webhook será acionado quando um texto do projeto for traduzido.

Exemplo de carga:

{
    "event": "suggestion.added",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Sugestão de tradução atualizada

O webhook será acionado quando a tradução adicionada anteriormente, para um texto do projeto for atualizado.

Exemplo de carga:

{
    "event": "suggestion.updated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Sugestão de tradução apagada

O webhook será acionado quando a tradução adicionada anteriormente, para o texto, for apagado.

Exemplo de carga:

{
    "event": "suggestion.deleted",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Sugestão de tradução aprovada

O webhook será acionado quando tradução adicionada anteriormente, para o texto, for aprovado.

Exemplo de carga:

{
    "event": "suggestion.approved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Sugestão de tradução desaprovada

O webhook será acionado quando a tradução adicionada anteriormente, para o texto, for desaprovado.

Exemplo de carga:

{
    "event": "suggestion.disapproved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Editar ou apagar webhooks

A lista dos webhooks existentes será mostrada na seção Webhooks. Pode editar ou apagar webhooks diretamente, da lista exibida.

Histórico de chamadas

O histórico de chamadas de todos os webhooks adicionados será acessível na mesma seção. Usa o filtro para verificar todas ou apenas as notificações mal-sucedidas do webhook.