Improve the callback documentation to help users better understand callbacks and how they work. Ideas of sections to add:
Calling mechanism: specify more clearly how notify calls the provided host (it does an HTTP POST request)
Expected response time: we expect the callback server to respond in a maximum of 1000ms
Expected volumes: expected volumes are in proportion to the user's send volume. If they send 100,000 emails, the callback server should be able to handle 100,000 callbacks.
WHY are we building?
To help our users better understand callbacks, how they work, and what we expect from them.
WHAT are we building?
Better documentation.
VALUE created by our solution
Users create callback servers appropriately and notifications and callbacks happen smoothly even under load.
Acceptance Criteria
Given some context, when (X) action occurs, then (Y) outcome is achieved
[ ] Cypress UI tests if needed.
[ ] Generate appropriate log messages so that executions of this feature can be tracked
[ ] Can misuse of this feature cause harm? If yes, create an alert
[ ] Update the status of related findings, insights, and hypotheses on the Research Airtable
[ ] Once change/fix/feature is implemented, link relevant Airtable records to design artifacts (Figma)
Description
Improve the callback documentation to help users better understand callbacks and how they work. Ideas of sections to add:
POSTrequest)100,000emails, the callback server should be able to handle100,000callbacks.WHY are we building?
To help our users better understand callbacks, how they work, and what we expect from them.
WHAT are we building?
Better documentation.
VALUE created by our solution
Users create callback servers appropriately and notifications and callbacks happen smoothly even under load.
Acceptance Criteria
Given some context, when (X) action occurs, then (Y) outcome is achieved
[ ] Cypress UI tests if needed.
[ ] Generate appropriate log messages so that executions of this feature can be tracked
[ ] Can misuse of this feature cause harm? If yes, create an alert
[ ] Update the status of related findings, insights, and hypotheses on the Research Airtable
[ ] Once change/fix/feature is implemented, link relevant Airtable records to design artifacts (Figma)
A11y
Bilingualism
Privacy considerations
Security controls in place
Measuring success and metrics
Related Research Airtable records
QA Steps
GC Articles Publish checklist