Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,15 @@
"webhooks/events/leaderboards/leaderboard-rank-changed",
"webhooks/events/leaderboards/leaderboard-finished"
]
},
{
"group": "Emails",
"pages": [
"webhooks/events/emails/recap-due",
"webhooks/events/emails/reactivation-due",
"webhooks/events/emails/streak-reminder-due",
"webhooks/events/emails/achievement-due"
]
}
]
},
Expand Down Expand Up @@ -683,6 +692,15 @@
"es/webhooks/events/leaderboards/leaderboard-rank-changed",
"es/webhooks/events/leaderboards/leaderboard-finished"
]
},
{
"group": "Correos",
"pages": [
"es/webhooks/events/emails/recap-due",
"es/webhooks/events/emails/reactivation-due",
"es/webhooks/events/emails/streak-reminder-due",
"es/webhooks/events/emails/achievement-due"
]
}
]
},
Expand Down
19 changes: 19 additions & 0 deletions es/features/emails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,25 @@ Para cada atributo al que desees restringir el correo, haz clic en el icono de m

Si especificas una zona horaria para cada usuario mediante [Identificación de Usuarios](/es/features/users#param-tz), Trophy utilizará esa zona horaria local para programar correos según la lógica especificada anteriormente. Si no proporcionas zonas horarias para los usuarios que identificas, Trophy utilizará por defecto la hora del Este.

### Enviar Correos Mediante Webhooks {#sending-emails-via-webhooks}

En lugar de que Trophy envíe los correos por ti, puedes suscribirte a los eventos de webhook de correos y enviar los mensajes tú mismo a través de tu propio proveedor o pipeline de correo electrónico.

Cuando un correo debería enviarse normalmente, Trophy dispara el webhook correspondiente para que puedas encargarte de la entrega:

- [`emails.recap_due`](/es/webhooks/events/emails/recap-due)
- [`emails.reactivation_due`](/es/webhooks/events/emails/reactivation-due)
- [`emails.streak_reminder_due`](/es/webhooks/events/emails/streak-reminder-due)
- [`emails.achievement_due`](/es/webhooks/events/emails/achievement-due)

Estos webhooks se disparan según los propios triggers de correo, independientemente de si alguna plantilla de correo está habilitada o deshabilitada, y de cualquier [filtro de atributo de usuario](#limiting-emails-to-specific-types-of-users) configurado en esas plantillas. Si necesitas un filtrado equivalente, aplícalo en tu manejador de webhook.

Los webhooks de correo respetan las [preferencias de notificación](/es/features/users#notification-preferences) y el [atributo `control`](/es/platform/experimentation#control-ratio) usado para experimentación. Trophy no disparará webhooks de correo para usuarios que se hayan dado de baja de ese tipo de correo, ni para usuarios en el grupo de control.

<Warning>
Si envías los correos tú mismo a partir de estos webhooks, asegúrate de que las plantillas de correo correspondientes estén desactivadas en Trophy. Los webhooks de correo siguen disparándose cuando los triggers corresponden incluso si las plantillas están deshabilitadas, pero si las plantillas siguen habilitadas Trophy también enviará sus propios correos, lo que resultará en entregas duplicadas.
</Warning>

## Diseño de Correos {#designing-emails}

Trophy cuenta con un editor de correos basado en bloques completamente funcional que te permite diseñar plantillas, controlando todo el texto del correo y las líneas de asunto. En la página de [correos](https://app.trophy.so/emails/configure), agrega plantillas en cada sección de [tipo de correo](#email-triggers) que desees usar.
Expand Down
8 changes: 8 additions & 0 deletions es/webhooks/events/emails/achievement-due.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Logro pendiente
openapi: openapi/application.yml webhook emails.achievement_due
---

<Note>
Obtén más información sobre [enviar correos mediante webhooks](/es/features/emails#sending-emails-via-webhooks), incluyendo cómo se relacionan estos eventos con las plantillas, las preferencias y la experimentación.
</Note>
8 changes: 8 additions & 0 deletions es/webhooks/events/emails/reactivation-due.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Reactivación pendiente
openapi: openapi/application.yml webhook emails.reactivation_due
---

<Note>
Obtén más información sobre [enviar correos mediante webhooks](/es/features/emails#sending-emails-via-webhooks), incluyendo cómo se relacionan estos eventos con las plantillas, las preferencias y la experimentación.
</Note>
8 changes: 8 additions & 0 deletions es/webhooks/events/emails/recap-due.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Resumen pendiente
openapi: openapi/application.yml webhook emails.recap_due
---

<Note>
Obtén más información sobre [enviar correos mediante webhooks](/es/features/emails#sending-emails-via-webhooks), incluyendo cómo se relacionan estos eventos con las plantillas, las preferencias y la experimentación.
</Note>
8 changes: 8 additions & 0 deletions es/webhooks/events/emails/streak-reminder-due.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Recordatorio de racha pendiente
openapi: openapi/application.yml webhook emails.streak_reminder_due
---

<Note>
Obtén más información sobre [enviar correos mediante webhooks](/es/features/emails#sending-emails-via-webhooks), incluyendo cómo se relacionan estos eventos con las plantillas, las preferencias y la experimentación.
</Note>
19 changes: 19 additions & 0 deletions features/emails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,25 @@ For each attribute you'd like to restrict the email to, click the plus icon next

If you specify a timezone for each user through [User Identification](/features/users#param-tz), Trophy will use that local time zone to schedule emails according to the logic specified above. If you do not provide time zones for the users you identify, Trophy will default to Eastern Time.

### Sending Emails Via Webhooks {#sending-emails-via-webhooks}

Instead of having Trophy send emails for you, you can subscribe to email webhook events and send messages yourself through your own email provider or pipeline.

When an email would normally be due, Trophy fires the corresponding webhook so you can handle delivery:

- [`emails.recap_due`](/webhooks/events/emails/recap-due)
- [`emails.reactivation_due`](/webhooks/events/emails/reactivation-due)
- [`emails.streak_reminder_due`](/webhooks/events/emails/streak-reminder-due)
- [`emails.achievement_due`](/webhooks/events/emails/achievement-due)

These webhooks fire based on the email triggers themselves, regardless of whether any email templates are enabled or disabled, and regardless of any [user attribute filters](#limiting-emails-to-specific-types-of-users) configured on those templates. If you need equivalent filtering, apply it in your webhook handler.

Email webhooks respect [notification preferences](/features/users#notification-preferences) and the [control attribute](/platform/experimentation#control-ratio) used for experimentation. Trophy will not fire email webhooks for users who have opted out of that email type, or for users in the control group.

<Warning>
If you are sending emails yourself from these webhooks, make sure the corresponding email templates are turned off in Trophy. Email webhooks still fire when triggers are due even if templates are disabled, but if templates remain enabled Trophy will also send its own emails resulting in duplicate delivery.
</Warning>

## Designing Emails {#designing-emails}

Trophy has a fully-featured block-based email builder that allows you to design templates, controlling all email copy and subject lines. On the [emails](https://app.trophy.so/emails/configure) page, add templates under each [email type](#email-triggers) section you want to use.
Expand Down
3 changes: 2 additions & 1 deletion i18n.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"features/*.mdx",
"webhooks/*.mdx",
"webhooks/events/achievements/*.mdx",
"webhooks/events/emails/*.mdx",
"webhooks/events/leaderboards/*.mdx",
"webhooks/events/points/*.mdx",
"webhooks/events/streaks/*.mdx",
Expand All @@ -45,4 +46,4 @@
]
}
}
}
}
Comment thread
cbrinicombe13 marked this conversation as resolved.
Loading
Loading