-
Notifications
You must be signed in to change notification settings - Fork 465
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
Conversation
782d1a5
to
d58bd97
Compare
There was a problem hiding this 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Event-bassed
type
There was a problem hiding this 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
d58bd97
to
5adb541
Compare
on-events
syntax in nango.yamlon-events
scriptshttps://linear.app/nango/issue/NAN-2219/on-events-script-follow-up
How to test:
npm run docs