-
Planes Team, Professional, Business, Enterprise y Software UI/UX
Ponte en contacto con Ventas para preguntas sobre licencias.
Los webhooks notifican a servicios externos como clientes de chat u otras APIs externas sobre eventos. Un webhook puede establecer una URL cuando ocurre un evento específico.
Importante
Las cargas de archivos solo activan los eventos de webhook uploads:create y uploads:processing.
Los eventos de webhook keys:create, keys:update, translations:create y translations:update no son activados por cargas de archivos o importaciones automatizadas a través de:
Hay un período de retención de 30 días para el historial de webhooks.
Respuesta del webhook
Un endpoint de webhook debe devolver un código de estado HTTP en el rango de 200–299 dentro de los 5 segundos de recibir una llamada de retorno. Otros códigos de estado y tiempos de espera de solicitud se consideran fallos de entrega. Un webhook se desactivará si la entrega falla durante más de 10 eventos consecutivos. Las llamadas de retorno no se repiten.
Si recibes una llamada de retorno, responde dentro del período de tiempo de espera de 5 segundos. Para asegurar que las aplicaciones no activen accidentalmente un tiempo de espera, difiere el procesamiento hasta después de que se haya enviado la respuesta HTTP.
Integridad de la solicitud de webhook
Cada solicitud de webhook incluye un X-PhraseApp-Signature encabezado que se genera utilizando el token de verificación de webhook como secreto junto con los datos enviados en la solicitud. Verifica el origen de la solicitud calculando el digest HMAC del cuerpo de la solicitud y comparándolo con el valor en el X-PhraseApp-Signature encabezado.
Ejemplos:
Ruby
def verify_webhook(signatureheader)
digest = OpenSSL::Digest::Digest.new('sha256')
hmac = OpenSSL::HMAC.digest(digest, VERIFICATION_TOKEN, request.body)
hmac = Base64.encode64(hmac).strip
hmac == signatureheader
end
PHP
function verify_webhook($signatureheader){
$hmac = hash_hmac('sha256', $requestBody, $verificationToken, true);
$hmac = trim(base64_encode($hash));
return $hmac == $signatureheader;
}
La estructura de cada carga útil de webhook está definida en un archivo de esquema disponible en https://app.phrase.com/webhook_schemas/<event_underscored_name>.json donde <event_underscored_name> corresponde al nombre del evento de webhook con guiones bajos.
branches:create se puede acceder a través de https://app.phrase.com/webhook_schemas/branches_create.json
|
Nombre del evento |
Descripción |
|---|---|
|
|
Se creó una rama. |
|
|
Se unió una rama. |
|
|
Se añadió un comentario a una clave de traducción. |
|
|
Se ha actualizado el valor de un campo de metadatos personalizado en múltiples claves. |
|
|
Se ha actualizado el valor de un campo de metadatos personalizado a nivel de clave. |
|
|
Se marcó un trabajo como completo. |
|
|
Se crea un trabajo. |
|
|
Se marcó la localización de un trabajo como completada. |
|
|
Se reabrió la localización de un trabajo. |
|
|
Se revisó la localización de un trabajo y se marcó como completa. |
|
|
Se revisó y reabrió la localización de un trabajo. |
|
|
Se reabrió un trabajo. |
|
|
Se inició un trabajo. |
|
|
Se actualiza un trabajo. |
|
|
Se eliminaron múltiples claves. |
|
|
Se creó una clave. |
|
|
Se eliminó una clave. |
|
|
Se añadieron etiquetas a múltiples claves. |
|
|
Se añadió una etiqueta a una clave. |
|
|
Se renombró o cambió una clave. |
|
|
Se creó una nueva versión del idioma en un proyecto. |
|
|
Se eliminó una versión del idioma. |
|
|
Se cambió, renombró o reconfiguró una versión del idioma. |
|
|
Se cambió o reconfiguró un proyecto. |
|
|
Se ha creado una versión OTA. |
|
|
Se ha eliminado una versión OTA. |
|
|
Se creó una captura de pantalla. |
|
|
Se eliminó una captura de pantalla. |
|
|
Se cambió o renombró una captura de pantalla. |
|
|
Se ha eliminado una lista de traducciones. |
|
|
Se ha incluido una lista de traducciones. |
|
|
Se ha revisado una lista de traducciones. |
|
|
Se ha desaprobado una lista de traducciones. |
|
|
Se ha sin verificar una lista de traducciones. |
|
|
Se ha verificado una lista de traducciones. |
|
|
Se ha añadido una traducción de una clave en una versión de idioma determinada. |
|
|
Se ha entregado una traducción de una clave en una versión de idioma determinada por un proveedor de servicios de idiomas. |
|
|
Se ha excluido una traducción de una clave en una versión de idioma determinada. |
|
|
Se ha incluido una traducción de una clave en una versión de idioma determinada. |
|
|
Se ha revisado una traducción de una clave en una versión de idioma determinada. |
|
|
Se ha desaprobado una traducción de una clave en una versión de idioma determinada. |
|
|
Se ha sin verificar una traducción de una clave en una versión de idioma determinada. |
|
|
Se editó la traducción de una clave en una versión de idioma determinada. |
|
|
Se verificó la traducción de una clave en una versión de idioma determinada. |
|
|
Un archivo de localización se procesó con éxito. |
|
|
Un archivo de localización está siendo procesado. |
Para agregar un webhook, sigue estos pasos:
-
Desde la página , desplázate hacia abajo hasta y haz clic en Configurar.
Se abre la página .
-
Haz clic en Agregar webhook.
Se abre la ventana .
-
Proporciona los detalles del webhook.
-
Opcionalmente .
-
Haz clic en Guardar. El webhook especificado se agrega a la lista en la página .
Un webhook se puede desactivar desde el menú de un webhook específico.
Para probar un webhook:
-
Desde la página , selecciona un webhook y selecciona Enviar notificación de prueba del menú .
Se presenta un aviso indicando que la prueba fue exitosa.
Usa un servicio como RequestBin para capturar el contenido de un webhook. RequestBin proporciona una URL que recopila datos de solicitud para inspección.
Se envía una solicitud POST a la URL de callback especificada cada vez que ocurre un evento del tipo especificado. La carga útil POST de la solicitud es un documento codificado en JSON con datos relevantes para el evento. Los atributos event, message y sent_at siempre estarán incluidos, junto con atributos adicionales relevantes para el evento como el usuario, proyecto y rama desde el cual se activó el webhook.
Encabezados de respuesta
Las solicitudes HTTP realizadas a la URL de callback contendrán varios encabezados especiales.
-
X-PhraseApp-Event: El tipo de evento que activó el webhook. -
X-PhraseApp-Signature: El digest hex HMAC de la carga útil, usando el secreto del hook como clave.
Ejemplo:
Content-Type: application/json
X-PhraseApp-Event: translation:create
X-PhraseApp-Signature: abc123
{
"event": "translations:create",
"message": "Peter tradujo page.help.title en fr.",
"sent_at": "2015-01-29T09:52:53Z"
"user": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"username": "joe.doe",
"name": "Joe Doe",
"email": "joe@phrase.com",
"position": "Desarrollador Principal",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z"
},
"project": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "My Android Project",
"main_format": "xml",
"project_image_url": "http://assets.phrase.com/project.png",
"account": "account",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z"
},
"branch": {
"name": "branch_name"
},
"translation": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"content": "My translation",
"unverified": false,
"excluded": false,
"plural_suffix": "",
"key": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "home.index.headline",
"plural": false
},
"locale": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "de",
"code": "de-DE"
},
"placeholders": [
"%{count}"
],
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z"
}
}