Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: How to add a send destination #3962

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

DafyddLlyr
Copy link
Contributor

@DafyddLlyr DafyddLlyr commented Nov 15, 2024

This is something I've been keeping track of whilst adding the GOSS integration, finally typed up my rough notes.

There's a lot of stuff here! Certainly a lot of room for improvement and simplification I think in this process, and it's what's inspired the questions raised in #3961

Ideally, we'd end up distilling this down to -

  • Custom validation in Editor (who can submit where - maybe driven by team_integrations table though?)
  • Custom authentication logic with integration
  • Custom payload generation for integration
  • Custom response handling with integration

I think the rest can largely be made generic and standard between send destinations.

As I keep working on GOSS using the existing setup, I'll dip in and out of the doc to update it or add more details. Thoughts very welcome on the outline that's currently here though.

@DafyddLlyr DafyddLlyr changed the title docs: How to add a send destination [skip pizza] docs: How to add a send destination Nov 15, 2024
@DafyddLlyr DafyddLlyr requested a review from a team November 15, 2024 12:06
- Submission handling (parse session, authenticate with send destination, construct payload for submission)
- Audit record creation (write to `new_destination_applications` table)
- Add `service.ts` layer for business logic
- Update `docs.yaml` Swagger file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Appreciate you outlining these steps - would personally order them differently though:

  1. Setup / planx-core
  2. Editor
  3. API
  4. Secret management

----- (above this line is usually enough to have a "proof of concept" to test on staging! often important to understand where this line is for fast external partner turn-around imo) -----

  1. Database (Hasura)
  2. Metabase
  3. Data sanitation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants