Skip to content

Overview

Concepts and Principles

Development

Overview

IDEs

API Explorer

Releases

Release Notes

TORO Integrate

Coder Studio

Coder Cloud

Bug Reports

Search

Endpoints

Endpoints are listeners triggered on events. They enable integration requirements where the system needs to consume and execute a specific logic (encapsulated in a Service) when an event is triggered. Each endpoint has a lifecycle bound to the package it resides in.

TORO Integrate ships with endpoint types that support events triggered from various sources:

The platform also provides auxiliary endpoints for:

Continue on the next pages to see a more detailed guide for each endpoint type.

Status

An endpoint's status indicates its current state and behavior. It only changes when an endpoint is started or stopped. Depending on the current status of an endpoint, some actions may or may not be performed. For instance, configuring an endpoint's properties or delete it is not possible unless the endpoint is stopped.

There are five possible endpoint statuses:

  • STOPPED

    The status of endpoints that are not running. In this state, an endpoint will not listen for events.

  • PAUSED

  • STARTED

    The status of endpoints that are currently running. In this state, an endpoint will listen for events and will act as configured once an event is intercepted.

  • STARTED_WITH_ERROR

    The status of endpoints that have managed to start-up but encountered non-fatal errors.

  • ERROR

    The status of endpoints that have completely failed to start-up because of fatal errors.

  • UNRECOGNIZED

    The status of endpoints whose states are unknown; if an endpoint has this as its status, it most likely means that the EndpointManager has failed to set the status properly.

An endpoint's state cannot be set manually; its value solely depends on what the EndpointManager assigns.