Endpoints

Introduction

Endpoints define how a workflow is triggered, and initializes the workflow with basic data. You can configure an endpoint to be triggerred through an api endpoint, a schedule, a database changes, or changes to an external integrations.

An Endpoint is the starting block for a workflow or an automation.

Example: A createMovie endpoint would take in movie parameters and create a movie with those parameters.

Creating an Endpoint

Create an endpoint by clicking on the + button in the navigation panel next to it's header.

You will see a new endpoint pop up on the graph with the the properties panel for the endpoint visible on the right side. Fill out the properties. Once done, close the properties panel to save your changes.

New endpoints won't be available in already live APIs unless published. See [Publishing] for more information.

Editing an Endpoint

You can edit an endpoint by clicking on the endpoint node on the graph. The properties panel will open up where you can edit all necessary properties.

Note: Some properties are editable but are not recommended to be edited once you go live with your project as they can cause loss of data. You will be shown a warning when performing such actions.

Note Although changes are saved automatically, they must be published for them to reflect in the Docs and be available for consumption.

Deleting an Endpoint

A endpoint can be deleted by simply right clicking on the endpoint and selecting delete.

Caution! This is a dangerous action and can cause permanent loss of data once the graph is published.