Magidoc

CloudEndpoint
Object

A cloud endpoint is a cloud hosted route that can be called by external services. This is normally configured through an integration.

Fields

#

id

ID !
Non-null

The ID of the cloud endpoint.

name

String !
Non-null

The name of the cloud endpoint.

handle

String !
Non-null

The handle of the cloud endpoint

description

String

A description of what this endpoint does.

cloudServiceId

ID !
Non-null

The ID of the cloud service this endpoint is associated with, if present

cloudService

CloudService !
Non-null

The cloud service that the endpoint is associated with.

integrationVersionId

ID !
Non-null

The ID of the installed integration this endpoint is associated with.

integrationVersion

IntegrationVersion !
Non-null

The installed integration that the endpoint is associated with.

methods

[ HTTPMethod !]!
Non-null

The method of the device endpoint.

mode

CloudEndpointMode !
Non-null

The mode of the cloud endpoint - e.g. GraphQL or JS

preHandler

String

A script to run to prepare variables etc for the endpoint

postHandler

String

A script to run to map the response back to the cloud service

module

String !
Non-null

The module to execute when the endpoint is called.

path

String !
Non-null

The path of the endpoint. This is nested under the base route and supports variables such as :id, or :state.

url

String !
Non-null

The full URL this can be reached at.

enabled

Boolean !
Non-null

Whether the device endpoint is enabled and serving requests.

logs

ActionLogConnection !
Non-null

The activity logs created by this endpoint's actions

createdAt

DateTimeISO !
Non-null

The date and time when the device endpoint was created.

updatedAt

DateTimeISO !
Non-null

The date and time when the device endpoint was last updated.

Usages

#

References

#

  • Field cloudEndpoint from Query