Skip to content

grindery-io/grindery-nexus-connector-helloworld

Repository files navigation

Sample Connector for Grindery Nexus

Development

A connector can contain any number of actions and triggers. See connector.ts for the sample implementation.

To test the connector, we can use npm run local:action and npm run local:trigger commands. They accept 2 parameters: key and fields. Example:

npm run local:action helloWorldAction '{"message":"Test"}'
npm run local:trigger helloWorldTrigger '{"interval":1000,"recurring":true}'

The connector will be run as a WebSocket server after deployment, to test it in production setting, run npm run server.

Webhook

Grindery Nexus supports HTTP inbound webhook for connectors, the URL is something like:

https://orchestrator.grindery.org/webhook/:connector_key/:trigger_key/:path

You can handle webhooks with webhooks parameter in ConnectorDefinition, see src/connector.ts.

CDS file

See also CDS file for this connector, this file is read by Grindery Nexus frontend and engine so that they can interact with the connector. You can also check schema of the file and other samples.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published