Skip to content
New issue

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

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

Already on GitHub? # to your account

docs: add docs for on-events scripts #3047

Merged
merged 2 commits into from
Nov 25, 2024
Merged

Conversation

TBonnin
Copy link
Collaborator

@TBonnin TBonnin commented Nov 22, 2024

  • Update integration configuration doc page to describe on-events syntax in nango.yaml
  • Adds a concept page to the docs to explain on-events scripts

https://linear.app/nango/issue/NAN-2219/on-events-script-follow-up

How to test: npm run docs

Copy link

linear bot commented Nov 22, 2024

@TBonnin TBonnin force-pushed the tbonnin/nan-2219/docs-on-events branch from 782d1a5 to d58bd97 Compare November 22, 2024 21:41
@TBonnin TBonnin requested a review from a team November 22, 2024 22:02
Copy link
Member

@bastienbeurier bastienbeurier left a comment

Choose a reason for hiding this comment

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

A couple questions:

  • Can we have templates for event-based scripts? How would this show up in the integration's endpoint list (since there's no endpoint for these scripts, right?).
  • Similarly, if I use a custom one, where will it show in the UI?

- They can modify external resource states.

# Scripts
Event-bassed executions are powered by [integration scripts](/understand/concepts/scripts) that encapsulate the logic for interfacing with external APIs. While Nango provides [script templates](understand/concepts/templates) for common use cases, there's also support for custom scripting to meet specific integration needs.
Copy link
Member

Choose a reason for hiding this comment

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

Event-bassed type

Copy link
Collaborator

@bodinsamuel bodinsamuel left a comment

Choose a reason for hiding this comment

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

👨‍⚕️

- They can make API calls to external systems.
- They can read existing connection data.
- They can log information for monitoring.
- They can modify external resource states.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if a table would be clearer

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

can you think of a place in the docs where we use a table to format similar info?

Copy link
Collaborator Author

@TBonnin TBonnin Nov 25, 2024

Choose a reason for hiding this comment

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

gonna merge but I will make a PR if we find a better way to format this info

@TBonnin TBonnin force-pushed the tbonnin/nan-2219/docs-on-events branch from d58bd97 to 5adb541 Compare November 25, 2024 16:31
@TBonnin TBonnin enabled auto-merge (squash) November 25, 2024 16:31
@TBonnin TBonnin merged commit 0306129 into master Nov 25, 2024
20 checks passed
@TBonnin TBonnin deleted the tbonnin/nan-2219/docs-on-events branch November 25, 2024 16:46
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants